honeybee-openstudio 2.0.0 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 316bc7465ea14eb23cdca97fe943459513d2a34d989d822fc821a6ff801e60e6
4
- data.tar.gz: 497e27a4d694073541229191642f1f0caf6ccd6eff226ac8dee7e60b88c6fb4f
3
+ metadata.gz: 34e31476710190775c1b58a796578e2762b592c7521d571185431df3dd2c0bce
4
+ data.tar.gz: e261ac7d892e16badc00bfba752ab57a63c373147ce805bca8c9e2e9ca31405b
5
5
  SHA512:
6
- metadata.gz: 331f16511e285305c2d0868be7f450067b1f3035d35d2cf905e9e66fdf553cec8812c7a81f9d322b98df33bbe8eff57105ef0bab29315c3bc8522f94a3499ec2
7
- data.tar.gz: 48cafa3e21c745c03bbc56d15275a025c56f0a27f5647153a4126ec0c9b8cc449b71d63bc7ab19f3844e7bae6f92038059ec3277358895469f44b3105bd09e42
6
+ metadata.gz: a1b39d70eb49ad7fa6eaf138b4808cd8701c0a9f6bfc68ba9d9b05f7385d8b3762029d1ef98d56818c801837890e94c87e1cc20dd49e977aafcdf2327f88aa8d
7
+ data.tar.gz: b3bc7170822b01e4c88b0ee7db34a1620147f4ff170423e316528a75fff0389ff325749cacdd8996deb4d945543b937cc8803d7214e0af94c908f1135112d5de
data/Gemfile CHANGED
@@ -11,8 +11,4 @@ else # get it from rubygems.org
11
11
  end
12
12
 
13
13
  # coveralls gem is used to generate coverage reports through CI
14
- gem 'coveralls', require: false
15
-
16
- # uncomment the following to run tests locally using `bundle exec rake`.
17
- # simplecov has an unneccesary dependency on native json gem, use fork that does not require this
18
- #gem 'simplecov', github: 'NREL/simplecov'
14
+ gem 'coveralls_reborn', require: false
data/README.md CHANGED
@@ -61,7 +61,7 @@ Then, you must install the OpenStudio Extension Gem itself with:
61
61
  ```
62
62
  gem install openstudio-extension
63
63
  ```
64
- Then, the specific dependencies of this measure can be installed by running:
64
+ Then, the specific dependencies of this repository can be installed by running:
65
65
  ```
66
66
  cd honeybee-openstudio-gem
67
67
  bundle update
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'honeybee-openstudio'
7
- spec.version = '2.0.0'
7
+ spec.version = '2.2.0'
8
8
  spec.authors = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
9
9
  spec.email = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
10
10
 
@@ -1,17 +1,15 @@
1
1
  source 'http://rubygems.org'
2
2
 
3
- ruby '2.2.4'
3
+ ruby '~> 2.5.0'
4
4
 
5
5
  allow_local = ENV['FAVOR_LOCAL_GEMS']
6
6
 
7
- gem 'urbanopt-reopt', '0.2.1'
8
-
9
7
  if allow_local && File.exist?('../urbanopt-scenario-gem')
10
8
  gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
11
9
  elsif allow_local
12
10
  gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
13
11
  else
14
- gem 'urbanopt-scenario', '0.2.0'
12
+ gem 'urbanopt-scenario', '~> 0.3.0'
15
13
  end
16
14
 
17
15
  if allow_local && File.exist?('../urbanopt-geojson-gem')
@@ -19,14 +17,8 @@ if allow_local && File.exist?('../urbanopt-geojson-gem')
19
17
  elsif allow_local
20
18
  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
21
19
  else
22
- gem 'urbanopt-geojson', '0.2.0'
20
+ gem 'urbanopt-geojson', '~> 0.3.0'
23
21
  end
24
22
 
25
23
  # include the honeybee-openstudio-gem
26
- gem 'honeybee-openstudio', '1.8.2'
27
-
28
- # simplecov has an unnecessary dependency on native json gem, use fork that does not require this
29
- gem 'simplecov', github: 'NREL/simplecov'
30
-
31
- # Specify exact rack version temporarily to work with Ruby 2.2.4
32
- gem 'rack', '2.1.2'
24
+ gem 'honeybee-openstudio', '2.1.0'
@@ -51,6 +51,7 @@ require 'from_honeybee/hvac/ideal_air'
51
51
  # import the construction objects
52
52
  require 'from_honeybee/construction/opaque'
53
53
  require 'from_honeybee/construction/window'
54
+ require 'from_honeybee/construction/windowshade'
54
55
  require 'from_honeybee/construction/shade'
55
56
  require 'from_honeybee/construction/air'
56
57
 
@@ -3,7 +3,7 @@
3
3
  "servers": [],
4
4
  "info": {
5
5
  "description": "This is the documentation for Honeybee model schema.",
6
- "version": "1.27.1",
6
+ "version": "1.32.0",
7
7
  "title": "Honeybee Model Schema",
8
8
  "contact": {
9
9
  "name": "Ladybug Tools",
@@ -159,6 +159,11 @@
159
159
  "x-displayName": "EnergyMaterial",
160
160
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyMaterial\" />\n"
161
161
  },
162
+ {
163
+ "name": "roughness_model",
164
+ "x-displayName": "Roughness",
165
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Roughness\" />\n"
166
+ },
162
167
  {
163
168
  "name": "energymaterialnomass_model",
164
169
  "x-displayName": "EnergyMaterialNoMass",
@@ -169,11 +174,21 @@
169
174
  "x-displayName": "EnergyWindowMaterialBlind",
170
175
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyWindowMaterialBlind\" />\n"
171
176
  },
177
+ {
178
+ "name": "slatorientation_model",
179
+ "x-displayName": "SlatOrientation",
180
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SlatOrientation\" />\n"
181
+ },
172
182
  {
173
183
  "name": "energywindowmaterialgas_model",
174
184
  "x-displayName": "EnergyWindowMaterialGas",
175
185
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyWindowMaterialGas\" />\n"
176
186
  },
187
+ {
188
+ "name": "gastype_model",
189
+ "x-displayName": "GasType",
190
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GasType\" />\n"
191
+ },
177
192
  {
178
193
  "name": "energywindowmaterialgascustom_model",
179
194
  "x-displayName": "EnergyWindowMaterialGasCustom",
@@ -204,6 +219,11 @@
204
219
  "x-displayName": "Face",
205
220
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Face\" />\n"
206
221
  },
222
+ {
223
+ "name": "facetype_model",
224
+ "x-displayName": "FaceType",
225
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FaceType\" />\n"
226
+ },
207
227
  {
208
228
  "name": "face3d_model",
209
229
  "x-displayName": "Face3D",
@@ -274,6 +294,11 @@
274
294
  "x-displayName": "IdealAirSystemAbridged",
275
295
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/IdealAirSystemAbridged\" />\n"
276
296
  },
297
+ {
298
+ "name": "economizertype_model",
299
+ "x-displayName": "EconomizerType",
300
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EconomizerType\" />\n"
301
+ },
277
302
  {
278
303
  "name": "infiltration_model",
279
304
  "x-displayName": "Infiltration",
@@ -299,6 +324,11 @@
299
324
  "x-displayName": "LightingAbridged",
300
325
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LightingAbridged\" />\n"
301
326
  },
327
+ {
328
+ "name": "metal_model",
329
+ "x-displayName": "Metal",
330
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Metal\" />\n"
331
+ },
302
332
  {
303
333
  "name": "mirror_model",
304
334
  "x-displayName": "Mirror",
@@ -309,6 +339,11 @@
309
339
  "x-displayName": "Model",
310
340
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Model\" />\n"
311
341
  },
342
+ {
343
+ "name": "units_model",
344
+ "x-displayName": "Units",
345
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Units\" />\n"
346
+ },
312
347
  {
313
348
  "name": "modelenergyproperties_model",
314
349
  "x-displayName": "ModelEnergyProperties",
@@ -384,6 +419,16 @@
384
419
  "x-displayName": "ProgramTypeAbridged",
385
420
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ProgramTypeAbridged\" />\n"
386
421
  },
422
+ {
423
+ "name": "radianceshadestateabridged_model",
424
+ "x-displayName": "RadianceShadeStateAbridged",
425
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RadianceShadeStateAbridged\" />\n"
426
+ },
427
+ {
428
+ "name": "radiancesubfacestateabridged_model",
429
+ "x-displayName": "RadianceSubFaceStateAbridged",
430
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RadianceSubFaceStateAbridged\" />\n"
431
+ },
387
432
  {
388
433
  "name": "roofceilingconstructionset_model",
389
434
  "x-displayName": "RoofCeilingConstructionSet",
@@ -459,6 +504,16 @@
459
504
  "x-displayName": "ScheduleTypeLimit",
460
505
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleTypeLimit\" />\n"
461
506
  },
507
+ {
508
+ "name": "schedulenumerictype_model",
509
+ "x-displayName": "ScheduleNumericType",
510
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleNumericType\" />\n"
511
+ },
512
+ {
513
+ "name": "scheduleunittype_model",
514
+ "x-displayName": "ScheduleUnitType",
515
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScheduleUnitType\" />\n"
516
+ },
462
517
  {
463
518
  "name": "setpoint_model",
464
519
  "x-displayName": "Setpoint",
@@ -504,6 +559,11 @@
504
559
  "x-displayName": "ShadeRadiancePropertiesAbridged",
505
560
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeRadiancePropertiesAbridged\" />\n"
506
561
  },
562
+ {
563
+ "name": "stategeometryabridged_model",
564
+ "x-displayName": "StateGeometryAbridged",
565
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/StateGeometryAbridged\" />\n"
566
+ },
507
567
  {
508
568
  "name": "surface_model",
509
569
  "x-displayName": "Surface",
@@ -558,6 +618,26 @@
558
618
  "name": "windowconstructionabridged_model",
559
619
  "x-displayName": "WindowConstructionAbridged",
560
620
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionAbridged\" />\n"
621
+ },
622
+ {
623
+ "name": "windowconstructionshade_model",
624
+ "x-displayName": "WindowConstructionShade",
625
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionShade\" />\n"
626
+ },
627
+ {
628
+ "name": "shadelocation_model",
629
+ "x-displayName": "ShadeLocation",
630
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeLocation\" />\n"
631
+ },
632
+ {
633
+ "name": "controltype_model",
634
+ "x-displayName": "ControlType",
635
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ControlType\" />\n"
636
+ },
637
+ {
638
+ "name": "windowconstructionshadeabridged_model",
639
+ "x-displayName": "WindowConstructionShadeAbridged",
640
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionShadeAbridged\" />\n"
561
641
  }
562
642
  ],
563
643
  "x-tagGroups": [
@@ -580,6 +660,7 @@
580
660
  "bsdf_model",
581
661
  "constructionset_model",
582
662
  "constructionsetabridged_model",
663
+ "controltype_model",
583
664
  "door_model",
584
665
  "doorconstructionset_model",
585
666
  "doorconstructionsetabridged_model",
@@ -588,6 +669,7 @@
588
669
  "doormodifiersetabridged_model",
589
670
  "doorpropertiesabridged_model",
590
671
  "doorradiancepropertiesabridged_model",
672
+ "economizertype_model",
591
673
  "electricequipment_model",
592
674
  "electricequipmentabridged_model",
593
675
  "energymaterial_model",
@@ -604,12 +686,14 @@
604
686
  "faceenergypropertiesabridged_model",
605
687
  "facepropertiesabridged_model",
606
688
  "faceradiancepropertiesabridged_model",
689
+ "facetype_model",
607
690
  "floorconstructionset_model",
608
691
  "floorconstructionsetabridged_model",
609
692
  "floormodifierset_model",
610
693
  "floormodifiersetabridged_model",
611
694
  "gasequipment_model",
612
695
  "gasequipmentabridged_model",
696
+ "gastype_model",
613
697
  "glass_model",
614
698
  "glow_model",
615
699
  "ground_model",
@@ -619,6 +703,7 @@
619
703
  "light_model",
620
704
  "lighting_model",
621
705
  "lightingabridged_model",
706
+ "metal_model",
622
707
  "mirror_model",
623
708
  "model_model",
624
709
  "modelenergyproperties_model",
@@ -636,6 +721,8 @@
636
721
  "plastic_model",
637
722
  "programtype_model",
638
723
  "programtypeabridged_model",
724
+ "radianceshadestateabridged_model",
725
+ "radiancesubfacestateabridged_model",
639
726
  "roofceilingconstructionset_model",
640
727
  "roofceilingconstructionsetabridged_model",
641
728
  "roofceilingmodifierset_model",
@@ -644,24 +731,31 @@
644
731
  "roomenergypropertiesabridged_model",
645
732
  "roompropertiesabridged_model",
646
733
  "roomradiancepropertiesabridged_model",
734
+ "roughness_model",
647
735
  "scheduleday_model",
648
736
  "schedulefixedinterval_model",
649
737
  "schedulefixedintervalabridged_model",
738
+ "schedulenumerictype_model",
650
739
  "scheduleruleabridged_model",
651
740
  "scheduleruleset_model",
652
741
  "schedulerulesetabridged_model",
653
742
  "scheduletypelimit_model",
743
+ "scheduleunittype_model",
654
744
  "setpoint_model",
655
745
  "setpointabridged_model",
656
746
  "shade_model",
657
747
  "shadeconstruction_model",
658
748
  "shadeenergypropertiesabridged_model",
749
+ "shadelocation_model",
659
750
  "shademodifierset_model",
660
751
  "shademodifiersetabridged_model",
661
752
  "shadepropertiesabridged_model",
662
753
  "shaderadiancepropertiesabridged_model",
754
+ "slatorientation_model",
755
+ "stategeometryabridged_model",
663
756
  "surface_model",
664
757
  "trans_model",
758
+ "units_model",
665
759
  "ventilation_model",
666
760
  "ventilationabridged_model",
667
761
  "void_model",
@@ -670,7 +764,9 @@
670
764
  "wallmodifierset_model",
671
765
  "wallmodifiersetabridged_model",
672
766
  "windowconstruction_model",
673
- "windowconstructionabridged_model"
767
+ "windowconstructionabridged_model",
768
+ "windowconstructionshade_model",
769
+ "windowconstructionshadeabridged_model"
674
770
  ]
675
771
  }
676
772
  ],
@@ -888,12 +984,12 @@
888
984
  "properties": {
889
985
  "boundary_condition_objects": {
890
986
  "title": "Boundary Condition Objects",
891
- "description": "A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacet and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.",
892
- "min_tems": 2,
987
+ "description": "A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.",
893
988
  "type": "array",
894
989
  "items": {
895
990
  "type": "string"
896
991
  },
992
+ "minItems": 2,
897
993
  "maxItems": 3
898
994
  },
899
995
  "type": {
@@ -930,7 +1026,7 @@
930
1026
  },
931
1027
  "transmittance_schedule": {
932
1028
  "title": "Transmittance Schedule",
933
- "description": "Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opauqe.",
1029
+ "description": "Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opaque.",
934
1030
  "maxLength": 100,
935
1031
  "minLength": 1,
936
1032
  "type": "string"
@@ -938,6 +1034,87 @@
938
1034
  },
939
1035
  "additionalProperties": false
940
1036
  },
1037
+ "StateGeometryAbridged": {
1038
+ "title": "StateGeometryAbridged",
1039
+ "description": "A single planar geometry that can be assigned to Radiance states.",
1040
+ "type": "object",
1041
+ "properties": {
1042
+ "identifier": {
1043
+ "title": "Identifier",
1044
+ "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
1045
+ "type": "string"
1046
+ },
1047
+ "geometry": {
1048
+ "title": "Geometry",
1049
+ "description": "A ladybug_geometry Face3D.",
1050
+ "allOf": [
1051
+ {
1052
+ "$ref": "#/components/schemas/Face3D"
1053
+ }
1054
+ ]
1055
+ },
1056
+ "display_name": {
1057
+ "title": "Display Name",
1058
+ "description": "Display name of the object with no character restrictions.",
1059
+ "type": "string"
1060
+ },
1061
+ "type": {
1062
+ "title": "Type",
1063
+ "default": "StateGeometryAbridged",
1064
+ "pattern": "^StateGeometryAbridged$",
1065
+ "type": "string",
1066
+ "readOnly": true
1067
+ },
1068
+ "modifier": {
1069
+ "title": "Modifier",
1070
+ "description": "A string for a Honeybee Radiance Modifier identifier (default: None).",
1071
+ "type": "string"
1072
+ },
1073
+ "modifier_direct": {
1074
+ "title": "Modifier Direct",
1075
+ "description": "A string for Honeybee Radiance Modifier identifiers to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
1076
+ "type": "string"
1077
+ }
1078
+ },
1079
+ "required": [
1080
+ "identifier",
1081
+ "geometry"
1082
+ ],
1083
+ "additionalProperties": false
1084
+ },
1085
+ "RadianceShadeStateAbridged": {
1086
+ "title": "RadianceShadeStateAbridged",
1087
+ "description": "RadianceShadeStateAbridged represents a single state for a dynamic Shade.",
1088
+ "type": "object",
1089
+ "properties": {
1090
+ "type": {
1091
+ "title": "Type",
1092
+ "default": "RadianceShadeStateAbridged",
1093
+ "pattern": "^RadianceShadeStateAbridged$",
1094
+ "type": "string",
1095
+ "readOnly": true
1096
+ },
1097
+ "modifier": {
1098
+ "title": "Modifier",
1099
+ "description": "A Radiance Modifier identifier (default: None).",
1100
+ "type": "string"
1101
+ },
1102
+ "modifier_direct": {
1103
+ "title": "Modifier Direct",
1104
+ "description": "A Radiance Modifier identifier (default: None).",
1105
+ "type": "string"
1106
+ },
1107
+ "shades": {
1108
+ "title": "Shades",
1109
+ "description": "A list of StateGeometryAbridged objects (default: None).",
1110
+ "type": "array",
1111
+ "items": {
1112
+ "$ref": "#/components/schemas/StateGeometryAbridged"
1113
+ }
1114
+ }
1115
+ },
1116
+ "additionalProperties": false
1117
+ },
941
1118
  "ShadeRadiancePropertiesAbridged": {
942
1119
  "title": "ShadeRadiancePropertiesAbridged",
943
1120
  "description": "Radiance Properties for Honeybee Shade Abridged.",
@@ -945,12 +1122,12 @@
945
1122
  "properties": {
946
1123
  "modifier": {
947
1124
  "title": "Modifier",
948
- "description": "A string for a Honeybee Radiance Modifier.",
1125
+ "description": "A string for a Honeybee Radiance Modifier (default: None).",
949
1126
  "type": "string"
950
1127
  },
951
1128
  "modifier_blk": {
952
1129
  "title": "Modifier Blk",
953
- "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects).",
1130
+ "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
954
1131
  "type": "string"
955
1132
  },
956
1133
  "type": {
@@ -959,6 +1136,19 @@
959
1136
  "pattern": "^ShadeRadiancePropertiesAbridged$",
960
1137
  "type": "string",
961
1138
  "readOnly": true
1139
+ },
1140
+ "dynamic_group_identifier": {
1141
+ "title": "Dynamic Group Identifier",
1142
+ "description": "An optional string to note the dynamic group ' 'to which the Shade is a part of. Shades sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Shade is assumed to be static. (default: None).",
1143
+ "type": "string"
1144
+ },
1145
+ "states": {
1146
+ "title": "States",
1147
+ "description": "An optional list of abridged states (default: None).",
1148
+ "type": "array",
1149
+ "items": {
1150
+ "$ref": "#/components/schemas/RadianceShadeStateAbridged"
1151
+ }
962
1152
  }
963
1153
  },
964
1154
  "additionalProperties": false
@@ -1060,6 +1250,57 @@
1060
1250
  },
1061
1251
  "additionalProperties": false
1062
1252
  },
1253
+ "RadianceSubFaceStateAbridged": {
1254
+ "title": "RadianceSubFaceStateAbridged",
1255
+ "description": "RadianceSubFaceStateAbridged is an abridged state for a dynamic Aperture or Door.\n ",
1256
+ "type": "object",
1257
+ "properties": {
1258
+ "type": {
1259
+ "title": "Type",
1260
+ "default": "RadianceSubFaceStateAbridged",
1261
+ "pattern": "^RadianceSubFaceStateAbridged$",
1262
+ "type": "string",
1263
+ "readOnly": true
1264
+ },
1265
+ "modifier": {
1266
+ "title": "Modifier",
1267
+ "description": "A Radiance Modifier identifier (default: None).",
1268
+ "type": "string"
1269
+ },
1270
+ "modifier_direct": {
1271
+ "title": "Modifier Direct",
1272
+ "description": "A Radiance Modifier identifier (default: None).",
1273
+ "type": "string"
1274
+ },
1275
+ "shades": {
1276
+ "title": "Shades",
1277
+ "description": "A list of StateGeometryAbridged objects (default: None).",
1278
+ "type": "array",
1279
+ "items": {
1280
+ "$ref": "#/components/schemas/StateGeometryAbridged"
1281
+ }
1282
+ },
1283
+ "vmtx_geometry": {
1284
+ "title": "Vmtx Geometry",
1285
+ "description": "A Face3D for the view matrix geometry (default: None).",
1286
+ "allOf": [
1287
+ {
1288
+ "$ref": "#/components/schemas/Face3D"
1289
+ }
1290
+ ]
1291
+ },
1292
+ "dmtx_geometry": {
1293
+ "title": "Dmtx Geometry",
1294
+ "description": "A Face3D for the daylight matrix geometry (default: None).",
1295
+ "allOf": [
1296
+ {
1297
+ "$ref": "#/components/schemas/Face3D"
1298
+ }
1299
+ ]
1300
+ }
1301
+ },
1302
+ "additionalProperties": false
1303
+ },
1063
1304
  "ApertureRadiancePropertiesAbridged": {
1064
1305
  "title": "ApertureRadiancePropertiesAbridged",
1065
1306
  "description": "Radiance Properties for Honeybee Aperture Abridged.",
@@ -1067,12 +1308,12 @@
1067
1308
  "properties": {
1068
1309
  "modifier": {
1069
1310
  "title": "Modifier",
1070
- "description": "A string for a Honeybee Radiance Modifier.",
1311
+ "description": "A string for a Honeybee Radiance Modifier (default: None).",
1071
1312
  "type": "string"
1072
1313
  },
1073
1314
  "modifier_blk": {
1074
1315
  "title": "Modifier Blk",
1075
- "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects).",
1316
+ "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
1076
1317
  "type": "string"
1077
1318
  },
1078
1319
  "type": {
@@ -1081,6 +1322,19 @@
1081
1322
  "pattern": "^ApertureRadiancePropertiesAbridged$",
1082
1323
  "type": "string",
1083
1324
  "readOnly": true
1325
+ },
1326
+ "dynamic_group_identifier": {
1327
+ "title": "Dynamic Group Identifier",
1328
+ "description": "An optional string to note the dynamic group ' 'to which the Aperture is a part of. Apertures sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Aperture is assumed to be static. (default: None).",
1329
+ "type": "string"
1330
+ },
1331
+ "states": {
1332
+ "title": "States",
1333
+ "description": "An optional list of abridged states (default: None).",
1334
+ "type": "array",
1335
+ "items": {
1336
+ "$ref": "#/components/schemas/RadianceSubFaceStateAbridged"
1337
+ }
1084
1338
  }
1085
1339
  },
1086
1340
  "additionalProperties": false
@@ -1223,12 +1477,12 @@
1223
1477
  "properties": {
1224
1478
  "modifier": {
1225
1479
  "title": "Modifier",
1226
- "description": "A string for a Honeybee Radiance Modifier.",
1480
+ "description": "A string for a Honeybee Radiance Modifier (default: None).",
1227
1481
  "type": "string"
1228
1482
  },
1229
1483
  "modifier_blk": {
1230
1484
  "title": "Modifier Blk",
1231
- "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects).",
1485
+ "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
1232
1486
  "type": "string"
1233
1487
  },
1234
1488
  "type": {
@@ -1237,6 +1491,19 @@
1237
1491
  "pattern": "^DoorRadiancePropertiesAbridged$",
1238
1492
  "type": "string",
1239
1493
  "readOnly": true
1494
+ },
1495
+ "dynamic_group_identifier": {
1496
+ "title": "Dynamic Group Identifier",
1497
+ "description": "An optional string to note the dynamic group ' 'to which the Door is a part of. Doors sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Door is assumed to be static. (default: None).",
1498
+ "type": "string"
1499
+ },
1500
+ "states": {
1501
+ "title": "States",
1502
+ "description": "An optional list of abridged states (default: None).",
1503
+ "type": "array",
1504
+ "items": {
1505
+ "$ref": "#/components/schemas/RadianceSubFaceStateAbridged"
1506
+ }
1240
1507
  }
1241
1508
  },
1242
1509
  "additionalProperties": false
@@ -1379,12 +1646,12 @@
1379
1646
  "properties": {
1380
1647
  "modifier": {
1381
1648
  "title": "Modifier",
1382
- "description": "A string for a Honeybee Radiance Modifier.",
1649
+ "description": "A string for a Honeybee Radiance Modifier (default: None).",
1383
1650
  "type": "string"
1384
1651
  },
1385
1652
  "modifier_blk": {
1386
1653
  "title": "Modifier Blk",
1387
- "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects).",
1654
+ "description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
1388
1655
  "type": "string"
1389
1656
  },
1390
1657
  "type": {
@@ -1439,13 +1706,12 @@
1439
1706
  ]
1440
1707
  },
1441
1708
  "face_type": {
1442
- "title": "Face Type",
1443
- "enum": [
1444
- "Wall",
1445
- "Floor",
1446
- "RoofCeiling",
1447
- "AirBoundary"
1709
+ "allOf": [
1710
+ {
1711
+ "$ref": "#/components/schemas/FaceType"
1712
+ }
1448
1713
  ],
1714
+ "title": "Face Type",
1449
1715
  "type": "string"
1450
1716
  },
1451
1717
  "boundary_condition": {
@@ -2238,6 +2504,14 @@
2238
2504
  "minimum": 1,
2239
2505
  "type": "integer",
2240
2506
  "format": "int32"
2507
+ },
2508
+ "story": {
2509
+ "title": "Story",
2510
+ "description": "Text string for the story identifier to which this Room belongs. Rooms sharing the same story identifier are considered part of the same story in a Model.",
2511
+ "maxLength": 100,
2512
+ "minLength": 1,
2513
+ "pattern": "[A-Za-z0-9_-]",
2514
+ "type": "string"
2241
2515
  }
2242
2516
  },
2243
2517
  "required": [
@@ -2390,7 +2664,7 @@
2390
2664
  },
2391
2665
  "operable_construction": {
2392
2666
  "title": "Operable Construction",
2393
- "description": "Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property..",
2667
+ "description": "Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
2394
2668
  "maxLength": 100,
2395
2669
  "minLength": 1,
2396
2670
  "type": "string"
@@ -2591,16 +2865,13 @@
2591
2865
  "readOnly": true
2592
2866
  },
2593
2867
  "roughness": {
2868
+ "allOf": [
2869
+ {
2870
+ "$ref": "#/components/schemas/Roughness"
2871
+ }
2872
+ ],
2594
2873
  "title": "Roughness",
2595
2874
  "default": "MediumRough",
2596
- "enum": [
2597
- "VeryRough",
2598
- "Rough",
2599
- "MediumRough",
2600
- "MediumSmooth",
2601
- "Smooth",
2602
- "VerySmooth"
2603
- ],
2604
2875
  "type": "string"
2605
2876
  },
2606
2877
  "thermal_absorptance": {
@@ -2672,16 +2943,13 @@
2672
2943
  "readOnly": true
2673
2944
  },
2674
2945
  "roughness": {
2946
+ "allOf": [
2947
+ {
2948
+ "$ref": "#/components/schemas/Roughness"
2949
+ }
2950
+ ],
2675
2951
  "title": "Roughness",
2676
2952
  "default": "MediumRough",
2677
- "enum": [
2678
- "VeryRough",
2679
- "Rough",
2680
- "MediumRough",
2681
- "MediumSmooth",
2682
- "Smooth",
2683
- "VerySmooth"
2684
- ],
2685
2953
  "type": "string"
2686
2954
  },
2687
2955
  "thermal_absorptance": {
@@ -2732,7 +3000,7 @@
2732
3000
  },
2733
3001
  "layers": {
2734
3002
  "title": "Layers",
2735
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
3003
+ "description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
2736
3004
  "minLength": 1,
2737
3005
  "maxLength": 100,
2738
3006
  "type": "array",
@@ -2746,7 +3014,7 @@
2746
3014
  },
2747
3015
  "materials": {
2748
3016
  "title": "Materials",
2749
- "description": "List of materials. The order of the materials is from outside to inside.",
3017
+ "description": "List of opaque materials. The order of the materials is from outside to inside.",
2750
3018
  "type": "array",
2751
3019
  "items": {
2752
3020
  "anyOf": [
@@ -2907,9 +3175,9 @@
2907
3175
  },
2908
3176
  "additionalProperties": false
2909
3177
  },
2910
- "EnergyWindowMaterialGas": {
2911
- "title": "EnergyWindowMaterialGas",
2912
- "description": "Create single layer of gas in a window construction.\n\nCan be combined with EnergyWindowMaterialGlazing to make multi-pane windows.",
3178
+ "EnergyWindowMaterialSimpleGlazSys": {
3179
+ "title": "EnergyWindowMaterialSimpleGlazSys",
3180
+ "description": "Describe an entire glazing system rather than individual layers.\n\nUsed when only very limited information is available on the glazing layers or when\nspecific performance levels are being targeted.",
2913
3181
  "type": "object",
2914
3182
  "properties": {
2915
3183
  "identifier": {
@@ -2919,6 +3187,22 @@
2919
3187
  "minLength": 1,
2920
3188
  "type": "string"
2921
3189
  },
3190
+ "u_factor": {
3191
+ "title": "U Factor",
3192
+ "description": "Used to describe the value for window system U-Factor, or overall heat transfer coefficient in W/(m2-K).",
3193
+ "exclusiveMinimum": 0,
3194
+ "maximum": 5.8,
3195
+ "type": "number",
3196
+ "format": "double"
3197
+ },
3198
+ "shgc": {
3199
+ "title": "Shgc",
3200
+ "description": "Unitless quantity describing Solar Heat Gain Coefficient for normal incidence and vertical orientation.",
3201
+ "exclusiveMinimum": 0,
3202
+ "exclusiveMaximum": 1,
3203
+ "type": "number",
3204
+ "format": "double"
3205
+ },
2922
3206
  "display_name": {
2923
3207
  "title": "Display Name",
2924
3208
  "description": "Display name of the object with no character restrictions.",
@@ -2926,39 +3210,31 @@
2926
3210
  },
2927
3211
  "type": {
2928
3212
  "title": "Type",
2929
- "default": "EnergyWindowMaterialGas",
2930
- "pattern": "^EnergyWindowMaterialGas$",
3213
+ "default": "EnergyWindowMaterialSimpleGlazSys",
3214
+ "pattern": "^EnergyWindowMaterialSimpleGlazSys$",
2931
3215
  "type": "string",
2932
3216
  "readOnly": true
2933
3217
  },
2934
- "thickness": {
2935
- "title": "Thickness",
2936
- "description": "Thickness of the gas layer in meters. Default value is 0.0125.",
2937
- "default": 0.0125,
3218
+ "vt": {
3219
+ "title": "Vt",
3220
+ "description": "The fraction of visible light falling on the window that makes it through the glass at normal incidence.",
3221
+ "default": 0.54,
2938
3222
  "exclusiveMinimum": 0,
3223
+ "exclusiveMaximum": 1,
2939
3224
  "type": "number",
2940
3225
  "format": "double"
2941
- },
2942
- "gas_type": {
2943
- "title": "Gas Type",
2944
- "default": "Air",
2945
- "enum": [
2946
- "Air",
2947
- "Argon",
2948
- "Krypton",
2949
- "Xenon"
2950
- ],
2951
- "type": "string"
2952
3226
  }
2953
3227
  },
2954
3228
  "required": [
2955
- "identifier"
3229
+ "identifier",
3230
+ "u_factor",
3231
+ "shgc"
2956
3232
  ],
2957
3233
  "additionalProperties": false
2958
3234
  },
2959
- "EnergyWindowMaterialGasCustom": {
2960
- "title": "EnergyWindowMaterialGasCustom",
2961
- "description": "Create single layer of custom gas.",
3235
+ "EnergyWindowMaterialGlazing": {
3236
+ "title": "EnergyWindowMaterialGlazing",
3237
+ "description": "Describe a single glass pane corresponding to a layer in a window construction.",
2962
3238
  "type": "object",
2963
3239
  "properties": {
2964
3240
  "identifier": {
@@ -2968,41 +3244,6 @@
2968
3244
  "minLength": 1,
2969
3245
  "type": "string"
2970
3246
  },
2971
- "conductivity_coeff_a": {
2972
- "title": "Conductivity Coeff A",
2973
- "description": "The A coefficient for gas conductivity in W/(m-K).",
2974
- "type": "number",
2975
- "format": "double"
2976
- },
2977
- "viscosity_coeff_a": {
2978
- "title": "Viscosity Coeff A",
2979
- "description": "The A coefficient for gas viscosity in kg/(m-s).",
2980
- "exclusiveMinimum": 0,
2981
- "type": "number",
2982
- "format": "double"
2983
- },
2984
- "specific_heat_coeff_a": {
2985
- "title": "Specific Heat Coeff A",
2986
- "description": "The A coefficient for gas specific heat in J/(kg-K).",
2987
- "exclusiveMinimum": 0,
2988
- "type": "number",
2989
- "format": "double"
2990
- },
2991
- "specific_heat_ratio": {
2992
- "title": "Specific Heat Ratio",
2993
- "description": "The specific heat ratio for gas.",
2994
- "exclusiveMinimum": 1,
2995
- "type": "number",
2996
- "format": "double"
2997
- },
2998
- "molecular_weight": {
2999
- "title": "Molecular Weight",
3000
- "description": "The molecular weight for gas in g/mol.",
3001
- "minimum": 20,
3002
- "maximum": 200,
3003
- "type": "number",
3004
- "format": "double"
3005
- },
3006
3247
  "display_name": {
3007
3248
  "title": "Display Name",
3008
3249
  "description": "Display name of the object with no character restrictions.",
@@ -3010,21 +3251,240 @@
3010
3251
  },
3011
3252
  "type": {
3012
3253
  "title": "Type",
3013
- "default": "EnergyWindowMaterialGasCustom",
3014
- "pattern": "^EnergyWindowMaterialGasCustom$",
3254
+ "default": "EnergyWindowMaterialGlazing",
3255
+ "pattern": "^EnergyWindowMaterialGlazing$",
3015
3256
  "type": "string",
3016
3257
  "readOnly": true
3017
3258
  },
3018
3259
  "thickness": {
3019
3260
  "title": "Thickness",
3020
- "description": "Thickness of the gas layer in meters. Default value is 0.0125.",
3021
- "default": 0.0125,
3261
+ "description": "The surface-to-surface of the glass in meters. Default value is 0.003.",
3262
+ "default": 0.003,
3022
3263
  "exclusiveMinimum": 0,
3023
3264
  "type": "number",
3024
3265
  "format": "double"
3025
3266
  },
3026
- "conductivity_coeff_b": {
3027
- "title": "Conductivity Coeff B",
3267
+ "solar_transmittance": {
3268
+ "title": "Solar Transmittance",
3269
+ "description": "Transmittance of solar radiation through the glass at normal incidence. Default value is 0.85 for clear glass.",
3270
+ "default": 0.85,
3271
+ "minimum": 0,
3272
+ "maximum": 1,
3273
+ "type": "number",
3274
+ "format": "double"
3275
+ },
3276
+ "solar_reflectance": {
3277
+ "title": "Solar Reflectance",
3278
+ "description": "Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default value is 0.075 for clear glass.",
3279
+ "default": 0.075,
3280
+ "minimum": 0,
3281
+ "maximum": 1,
3282
+ "type": "number",
3283
+ "format": "double"
3284
+ },
3285
+ "solar_reflectance_back": {
3286
+ "title": "Solar Reflectance Back",
3287
+ "description": "Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.",
3288
+ "type": "number",
3289
+ "format": "double"
3290
+ },
3291
+ "visible_transmittance": {
3292
+ "title": "Visible Transmittance",
3293
+ "description": "Transmittance of visible light through the glass at normal incidence. Default value is 0.9 for clear glass.",
3294
+ "default": 0.9,
3295
+ "minimum": 0,
3296
+ "maximum": 1,
3297
+ "type": "number",
3298
+ "format": "double"
3299
+ },
3300
+ "visible_reflectance": {
3301
+ "title": "Visible Reflectance",
3302
+ "description": "Reflectance of visible light off of the front side of the glass at normal incidence. Default value is 0.075 for clear glass.",
3303
+ "default": 0.075,
3304
+ "minimum": 0,
3305
+ "maximum": 1,
3306
+ "type": "number",
3307
+ "format": "double"
3308
+ },
3309
+ "visible_reflectance_back": {
3310
+ "title": "Visible Reflectance Back",
3311
+ "description": "Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.",
3312
+ "minimum": 0,
3313
+ "maximum": 1,
3314
+ "type": "number",
3315
+ "format": "double"
3316
+ },
3317
+ "infrared_transmittance": {
3318
+ "title": "Infrared Transmittance",
3319
+ "description": "Long-wave transmittance at normal incidence.",
3320
+ "default": 0,
3321
+ "minimum": 0,
3322
+ "maximum": 1,
3323
+ "type": "number",
3324
+ "format": "double"
3325
+ },
3326
+ "emissivity": {
3327
+ "title": "Emissivity",
3328
+ "description": "Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3329
+ "default": 0.84,
3330
+ "minimum": 0,
3331
+ "maximum": 1,
3332
+ "type": "number",
3333
+ "format": "double"
3334
+ },
3335
+ "emissivity_back": {
3336
+ "title": "Emissivity Back",
3337
+ "description": "Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3338
+ "default": 0.84,
3339
+ "minimum": 0,
3340
+ "maximum": 1,
3341
+ "type": "number",
3342
+ "format": "double"
3343
+ },
3344
+ "conductivity": {
3345
+ "title": "Conductivity",
3346
+ "description": "Thermal conductivity of the glass in W/(m-K). Default value is 0.9, which is typical for clear glass without a low-e coating.",
3347
+ "default": 0.9,
3348
+ "exclusiveMinimum": 0,
3349
+ "type": "number",
3350
+ "format": "double"
3351
+ },
3352
+ "dirt_correction": {
3353
+ "title": "Dirt Correction",
3354
+ "description": "Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.",
3355
+ "default": 1,
3356
+ "type": "number",
3357
+ "format": "double"
3358
+ },
3359
+ "solar_diffusing": {
3360
+ "title": "Solar Diffusing",
3361
+ "description": "Takes values True and False. If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.",
3362
+ "default": false,
3363
+ "type": "boolean"
3364
+ }
3365
+ },
3366
+ "required": [
3367
+ "identifier"
3368
+ ],
3369
+ "additionalProperties": false
3370
+ },
3371
+ "EnergyWindowMaterialGas": {
3372
+ "title": "EnergyWindowMaterialGas",
3373
+ "description": "Create single layer of gas in a window construction.\n\nCan be combined with EnergyWindowMaterialGlazing to make multi-pane windows.",
3374
+ "type": "object",
3375
+ "properties": {
3376
+ "identifier": {
3377
+ "title": "Identifier",
3378
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3379
+ "maxLength": 100,
3380
+ "minLength": 1,
3381
+ "type": "string"
3382
+ },
3383
+ "display_name": {
3384
+ "title": "Display Name",
3385
+ "description": "Display name of the object with no character restrictions.",
3386
+ "type": "string"
3387
+ },
3388
+ "type": {
3389
+ "title": "Type",
3390
+ "default": "EnergyWindowMaterialGas",
3391
+ "pattern": "^EnergyWindowMaterialGas$",
3392
+ "type": "string",
3393
+ "readOnly": true
3394
+ },
3395
+ "thickness": {
3396
+ "title": "Thickness",
3397
+ "description": "Thickness of the gas layer in meters. Default value is 0.0125.",
3398
+ "default": 0.0125,
3399
+ "exclusiveMinimum": 0,
3400
+ "type": "number",
3401
+ "format": "double"
3402
+ },
3403
+ "gas_type": {
3404
+ "allOf": [
3405
+ {
3406
+ "$ref": "#/components/schemas/GasType"
3407
+ }
3408
+ ],
3409
+ "title": "Gas Type",
3410
+ "default": "Air",
3411
+ "type": "string"
3412
+ }
3413
+ },
3414
+ "required": [
3415
+ "identifier"
3416
+ ],
3417
+ "additionalProperties": false
3418
+ },
3419
+ "EnergyWindowMaterialGasCustom": {
3420
+ "title": "EnergyWindowMaterialGasCustom",
3421
+ "description": "Create single layer of custom gas.",
3422
+ "type": "object",
3423
+ "properties": {
3424
+ "identifier": {
3425
+ "title": "Identifier",
3426
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3427
+ "maxLength": 100,
3428
+ "minLength": 1,
3429
+ "type": "string"
3430
+ },
3431
+ "conductivity_coeff_a": {
3432
+ "title": "Conductivity Coeff A",
3433
+ "description": "The A coefficient for gas conductivity in W/(m-K).",
3434
+ "type": "number",
3435
+ "format": "double"
3436
+ },
3437
+ "viscosity_coeff_a": {
3438
+ "title": "Viscosity Coeff A",
3439
+ "description": "The A coefficient for gas viscosity in kg/(m-s).",
3440
+ "exclusiveMinimum": 0,
3441
+ "type": "number",
3442
+ "format": "double"
3443
+ },
3444
+ "specific_heat_coeff_a": {
3445
+ "title": "Specific Heat Coeff A",
3446
+ "description": "The A coefficient for gas specific heat in J/(kg-K).",
3447
+ "exclusiveMinimum": 0,
3448
+ "type": "number",
3449
+ "format": "double"
3450
+ },
3451
+ "specific_heat_ratio": {
3452
+ "title": "Specific Heat Ratio",
3453
+ "description": "The specific heat ratio for gas.",
3454
+ "exclusiveMinimum": 1,
3455
+ "type": "number",
3456
+ "format": "double"
3457
+ },
3458
+ "molecular_weight": {
3459
+ "title": "Molecular Weight",
3460
+ "description": "The molecular weight for gas in g/mol.",
3461
+ "minimum": 20,
3462
+ "maximum": 200,
3463
+ "type": "number",
3464
+ "format": "double"
3465
+ },
3466
+ "display_name": {
3467
+ "title": "Display Name",
3468
+ "description": "Display name of the object with no character restrictions.",
3469
+ "type": "string"
3470
+ },
3471
+ "type": {
3472
+ "title": "Type",
3473
+ "default": "EnergyWindowMaterialGasCustom",
3474
+ "pattern": "^EnergyWindowMaterialGasCustom$",
3475
+ "type": "string",
3476
+ "readOnly": true
3477
+ },
3478
+ "thickness": {
3479
+ "title": "Thickness",
3480
+ "description": "Thickness of the gas layer in meters. Default value is 0.0125.",
3481
+ "default": 0.0125,
3482
+ "exclusiveMinimum": 0,
3483
+ "type": "number",
3484
+ "format": "double"
3485
+ },
3486
+ "conductivity_coeff_b": {
3487
+ "title": "Conductivity Coeff B",
3028
3488
  "description": "The B coefficient for gas conductivity in W/(m-K2).",
3029
3489
  "default": 0,
3030
3490
  "type": "number",
@@ -3093,11 +3553,10 @@
3093
3553
  "description": "List of gases in the gas mixture.",
3094
3554
  "type": "array",
3095
3555
  "items": {
3096
- "enum": [
3097
- "Air",
3098
- "Argon",
3099
- "Krypton",
3100
- "Xenon"
3556
+ "allOf": [
3557
+ {
3558
+ "$ref": "#/components/schemas/GasType"
3559
+ }
3101
3560
  ],
3102
3561
  "type": "string"
3103
3562
  },
@@ -3143,9 +3602,9 @@
3143
3602
  ],
3144
3603
  "additionalProperties": false
3145
3604
  },
3146
- "EnergyWindowMaterialSimpleGlazSys": {
3147
- "title": "EnergyWindowMaterialSimpleGlazSys",
3148
- "description": "Describe an entire glazing system rather than individual layers.\n\nUsed when only very limited information is available on the glazing layers or when\nspecific performance levels are being targeted.",
3605
+ "WindowConstruction": {
3606
+ "title": "WindowConstruction",
3607
+ "description": "Construction for window objects (Aperture, Door).",
3149
3608
  "type": "object",
3150
3609
  "properties": {
3151
3610
  "identifier": {
@@ -3155,54 +3614,180 @@
3155
3614
  "minLength": 1,
3156
3615
  "type": "string"
3157
3616
  },
3158
- "u_factor": {
3159
- "title": "U Factor",
3160
- "description": "Used to describe the value for window system U-Factor, or overall heat transfer coefficient in W/(m2-K).",
3161
- "exclusiveMinimum": 0,
3162
- "maximum": 5.8,
3163
- "type": "number",
3164
- "format": "double"
3165
- },
3166
- "shgc": {
3167
- "title": "Shgc",
3168
- "description": "Unitless quantity describing Solar Heat Gain Coefficient for normal incidence and vertical orientation.",
3169
- "exclusiveMinimum": 0,
3170
- "exclusiveMaximum": 1,
3171
- "type": "number",
3172
- "format": "double"
3617
+ "layers": {
3618
+ "title": "Layers",
3619
+ "description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
3620
+ "minLength": 1,
3621
+ "maxLength": 100,
3622
+ "type": "array",
3623
+ "items": {
3624
+ "type": "string",
3625
+ "minLength": 1,
3626
+ "maxLength": 100
3627
+ },
3628
+ "minItems": 1,
3629
+ "maxItems": 8
3173
3630
  },
3174
- "display_name": {
3631
+ "materials": {
3632
+ "title": "Materials",
3633
+ "description": "List of glazing and gas materials. The order of the materials is from outside to inside. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
3634
+ "type": "array",
3635
+ "items": {
3636
+ "anyOf": [
3637
+ {
3638
+ "$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
3639
+ },
3640
+ {
3641
+ "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
3642
+ },
3643
+ {
3644
+ "$ref": "#/components/schemas/EnergyWindowMaterialGas"
3645
+ },
3646
+ {
3647
+ "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
3648
+ },
3649
+ {
3650
+ "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
3651
+ }
3652
+ ]
3653
+ },
3654
+ "minItems": 1,
3655
+ "maxItems": 8
3656
+ },
3657
+ "display_name": {
3175
3658
  "title": "Display Name",
3176
3659
  "description": "Display name of the object with no character restrictions.",
3177
3660
  "type": "string"
3178
3661
  },
3179
3662
  "type": {
3180
3663
  "title": "Type",
3181
- "default": "EnergyWindowMaterialSimpleGlazSys",
3182
- "pattern": "^EnergyWindowMaterialSimpleGlazSys$",
3664
+ "default": "WindowConstruction",
3665
+ "pattern": "^WindowConstruction$",
3183
3666
  "type": "string",
3184
3667
  "readOnly": true
3185
- },
3186
- "vt": {
3187
- "title": "Vt",
3188
- "description": "The fraction of visible light falling on the window that makes it through the glass at normal incidence.",
3189
- "default": 0.54,
3190
- "exclusiveMinimum": 0,
3191
- "exclusiveMaximum": 1,
3192
- "type": "number",
3193
- "format": "double"
3194
3668
  }
3195
3669
  },
3196
3670
  "required": [
3197
3671
  "identifier",
3198
- "u_factor",
3199
- "shgc"
3672
+ "layers",
3673
+ "materials"
3200
3674
  ],
3201
3675
  "additionalProperties": false
3202
3676
  },
3203
- "EnergyWindowMaterialBlind": {
3204
- "title": "EnergyWindowMaterialBlind",
3205
- "description": "Window blind material consisting of flat, equally-spaced slats.",
3677
+ "ApertureConstructionSet": {
3678
+ "title": "ApertureConstructionSet",
3679
+ "description": "A set of constructions for aperture assemblies.",
3680
+ "type": "object",
3681
+ "properties": {
3682
+ "type": {
3683
+ "title": "Type",
3684
+ "default": "ApertureConstructionSet",
3685
+ "pattern": "^ApertureConstructionSet$",
3686
+ "type": "string",
3687
+ "readOnly": true
3688
+ },
3689
+ "interior_construction": {
3690
+ "title": "Interior Construction",
3691
+ "description": "A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
3692
+ "allOf": [
3693
+ {
3694
+ "$ref": "#/components/schemas/WindowConstruction"
3695
+ }
3696
+ ]
3697
+ },
3698
+ "window_construction": {
3699
+ "title": "Window Construction",
3700
+ "description": "A WindowConstruction for all apertures with a Surface boundary condition.",
3701
+ "allOf": [
3702
+ {
3703
+ "$ref": "#/components/schemas/WindowConstruction"
3704
+ }
3705
+ ]
3706
+ },
3707
+ "skylight_construction": {
3708
+ "title": "Skylight Construction",
3709
+ "description": "A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
3710
+ "allOf": [
3711
+ {
3712
+ "$ref": "#/components/schemas/WindowConstruction"
3713
+ }
3714
+ ]
3715
+ },
3716
+ "operable_construction": {
3717
+ "title": "Operable Construction",
3718
+ "description": "A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
3719
+ "allOf": [
3720
+ {
3721
+ "$ref": "#/components/schemas/WindowConstruction"
3722
+ }
3723
+ ]
3724
+ }
3725
+ },
3726
+ "additionalProperties": false
3727
+ },
3728
+ "DoorConstructionSet": {
3729
+ "title": "DoorConstructionSet",
3730
+ "description": "A set of constructions for door assemblies.",
3731
+ "type": "object",
3732
+ "properties": {
3733
+ "type": {
3734
+ "title": "Type",
3735
+ "default": "DoorConstructionSet",
3736
+ "pattern": "^DoorConstructionSet$",
3737
+ "type": "string",
3738
+ "readOnly": true
3739
+ },
3740
+ "interior_construction": {
3741
+ "title": "Interior Construction",
3742
+ "description": "An OpaqueConstruction for all opaque doors with a Surface boundary condition.",
3743
+ "allOf": [
3744
+ {
3745
+ "$ref": "#/components/schemas/OpaqueConstruction"
3746
+ }
3747
+ ]
3748
+ },
3749
+ "exterior_construction": {
3750
+ "title": "Exterior Construction",
3751
+ "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
3752
+ "allOf": [
3753
+ {
3754
+ "$ref": "#/components/schemas/OpaqueConstruction"
3755
+ }
3756
+ ]
3757
+ },
3758
+ "overhead_construction": {
3759
+ "title": "Overhead Construction",
3760
+ "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
3761
+ "allOf": [
3762
+ {
3763
+ "$ref": "#/components/schemas/OpaqueConstruction"
3764
+ }
3765
+ ]
3766
+ },
3767
+ "exterior_glass_construction": {
3768
+ "title": "Exterior Glass Construction",
3769
+ "description": "A WindowConstruction for all glass doors with an Outdoors boundary condition.",
3770
+ "allOf": [
3771
+ {
3772
+ "$ref": "#/components/schemas/WindowConstruction"
3773
+ }
3774
+ ]
3775
+ },
3776
+ "interior_glass_construction": {
3777
+ "title": "Interior Glass Construction",
3778
+ "description": "A WindowConstruction for all glass doors with a Surface boundary condition.",
3779
+ "allOf": [
3780
+ {
3781
+ "$ref": "#/components/schemas/WindowConstruction"
3782
+ }
3783
+ ]
3784
+ }
3785
+ },
3786
+ "additionalProperties": false
3787
+ },
3788
+ "ShadeConstruction": {
3789
+ "title": "ShadeConstruction",
3790
+ "description": "Construction for Shade objects.",
3206
3791
  "type": "object",
3207
3792
  "properties": {
3208
3793
  "identifier": {
@@ -3219,379 +3804,294 @@
3219
3804
  },
3220
3805
  "type": {
3221
3806
  "title": "Type",
3222
- "default": "EnergyWindowMaterialBlind",
3223
- "pattern": "^EnergyWindowMaterialBlind$",
3807
+ "default": "ShadeConstruction",
3808
+ "pattern": "^ShadeConstruction$",
3224
3809
  "type": "string",
3225
3810
  "readOnly": true
3226
3811
  },
3227
- "slat_orientation": {
3228
- "title": "Slat Orientation",
3229
- "default": "Horizontal",
3230
- "enum": [
3231
- "Horizontal",
3232
- "Vertical"
3233
- ],
3234
- "type": "string"
3235
- },
3236
- "slat_width": {
3237
- "title": "Slat Width",
3238
- "description": "The width of slat measured from edge to edge in meters.",
3239
- "default": 0.025,
3240
- "exclusiveMinimum": 0,
3812
+ "solar_reflectance": {
3813
+ "title": "Solar Reflectance",
3814
+ "description": "A number for the solar reflectance of the construction.",
3815
+ "default": 0.2,
3816
+ "minimum": 0,
3241
3817
  "maximum": 1,
3242
3818
  "type": "number",
3243
3819
  "format": "double"
3244
3820
  },
3245
- "slat_separation": {
3246
- "title": "Slat Separation",
3247
- "description": "The distance between the front of a slat and the back of the adjacent slat in meters.",
3248
- "default": 0.01875,
3249
- "exclusiveMinimum": 0,
3821
+ "visible_reflectance": {
3822
+ "title": "Visible Reflectance",
3823
+ "description": "A number for the visible reflectance of the construction.",
3824
+ "default": 0.2,
3825
+ "minimum": 0,
3250
3826
  "maximum": 1,
3251
3827
  "type": "number",
3252
3828
  "format": "double"
3253
3829
  },
3254
- "slat_thickness": {
3255
- "title": "Slat Thickness",
3256
- "description": "The distance between the faces of a slat in meters. The default value is 0.001.",
3257
- "default": 0.001,
3258
- "exclusiveMinimum": 0,
3259
- "maximum": 0.1,
3260
- "type": "number",
3261
- "format": "double"
3262
- },
3263
- "slat_angle": {
3264
- "title": "Slat Angle",
3265
- "description": "The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.",
3266
- "default": 45,
3267
- "minimum": 0,
3268
- "maximum": 180,
3269
- "type": "number",
3270
- "format": "double"
3830
+ "is_specular": {
3831
+ "title": "Is Specular",
3832
+ "description": "Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.",
3833
+ "default": false,
3834
+ "type": "boolean"
3835
+ }
3836
+ },
3837
+ "required": [
3838
+ "identifier"
3839
+ ],
3840
+ "additionalProperties": false
3841
+ },
3842
+ "ScheduleDay": {
3843
+ "title": "ScheduleDay",
3844
+ "description": "Used to describe the daily schedule for a single simulation day.",
3845
+ "type": "object",
3846
+ "properties": {
3847
+ "identifier": {
3848
+ "title": "Identifier",
3849
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3850
+ "maxLength": 100,
3851
+ "minLength": 1,
3852
+ "type": "string"
3271
3853
  },
3272
- "slat_conductivity": {
3273
- "title": "Slat Conductivity",
3274
- "description": "The thermal conductivity of the slat in W/(m-K). Default value is 221.",
3275
- "default": 221,
3276
- "exclusiveMinimum": 0,
3277
- "type": "number",
3278
- "format": "double"
3854
+ "values": {
3855
+ "title": "Values",
3856
+ "description": "A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.",
3857
+ "type": "array",
3858
+ "items": {
3859
+ "type": "number",
3860
+ "format": "double"
3861
+ }
3279
3862
  },
3280
- "beam_solar_transmittance": {
3281
- "title": "Beam Solar Transmittance",
3282
- "description": "The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.",
3283
- "default": 0,
3284
- "exclusiveMaximum": 1,
3285
- "minimum": 0,
3286
- "type": "number",
3287
- "format": "double"
3863
+ "display_name": {
3864
+ "title": "Display Name",
3865
+ "description": "Display name of the object with no character restrictions.",
3866
+ "type": "string"
3288
3867
  },
3289
- "beam_solar_reflectance": {
3290
- "title": "Beam Solar Reflectance",
3291
- "description": "The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3292
- "default": 0.5,
3293
- "exclusiveMaximum": 1,
3294
- "minimum": 0,
3295
- "type": "number",
3296
- "format": "double"
3297
- },
3298
- "beam_solar_reflectance_back": {
3299
- "title": "Beam Solar Reflectance Back",
3300
- "description": "The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3301
- "default": 0.5,
3302
- "exclusiveMaximum": 1,
3303
- "minimum": 0,
3304
- "type": "number",
3305
- "format": "double"
3306
- },
3307
- "diffuse_solar_transmittance": {
3308
- "title": "Diffuse Solar Transmittance",
3309
- "description": "The slat transmittance for hemisperically diffuse solar radiation. Default value is 0.",
3310
- "default": 0,
3311
- "exclusiveMaximum": 1,
3312
- "minimum": 0,
3313
- "type": "number",
3314
- "format": "double"
3315
- },
3316
- "diffuse_solar_reflectance": {
3317
- "title": "Diffuse Solar Reflectance",
3318
- "description": "The front-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
3319
- "default": 0.5,
3320
- "exclusiveMaximum": 1,
3321
- "minimum": 0,
3322
- "type": "number",
3323
- "format": "double"
3324
- },
3325
- "diffuse_solar_reflectance_back": {
3326
- "title": "Diffuse Solar Reflectance Back",
3327
- "description": "The back-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
3328
- "default": 0.5,
3329
- "exclusiveMaximum": 1,
3330
- "minimum": 0,
3331
- "type": "number",
3332
- "format": "double"
3333
- },
3334
- "beam_visible_transmittance": {
3335
- "title": "Beam Visible Transmittance",
3336
- "description": "The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.",
3337
- "default": 0,
3338
- "exclusiveMaximum": 1,
3339
- "minimum": 0,
3340
- "type": "number",
3341
- "format": "double"
3342
- },
3343
- "beam_visible_reflectance": {
3344
- "title": "Beam Visible Reflectance",
3345
- "description": "The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3346
- "default": 0.5,
3347
- "exclusiveMaximum": 1,
3348
- "minimum": 0,
3349
- "type": "number",
3350
- "format": "double"
3351
- },
3352
- "beam_visible_reflectance_back": {
3353
- "title": "Beam Visible Reflectance Back",
3354
- "description": "The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3355
- "default": 0.5,
3356
- "exclusiveMaximum": 1,
3357
- "minimum": 0,
3358
- "type": "number",
3359
- "format": "double"
3360
- },
3361
- "diffuse_visible_transmittance": {
3362
- "title": "Diffuse Visible Transmittance",
3363
- "description": "The slat transmittance for hemispherically diffuse visible radiation. This value should equal \u201cSlat Beam Visible Transmittance.\u201d",
3364
- "default": 0,
3365
- "exclusiveMaximum": 1,
3366
- "minimum": 0,
3367
- "type": "number",
3368
- "format": "double"
3369
- },
3370
- "diffuse_visible_reflectance": {
3371
- "title": "Diffuse Visible Reflectance",
3372
- "description": "The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cFront Side Slat Beam Visible Reflectance.\u201d Default value is 0.5.",
3373
- "default": 0.5,
3374
- "exclusiveMaximum": 1,
3375
- "minimum": 0,
3376
- "type": "number",
3377
- "format": "double"
3378
- },
3379
- "diffuse_visible_reflectance_back": {
3380
- "title": "Diffuse Visible Reflectance Back",
3381
- "description": "The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cBack Side Slat Beam Visible Reflectance. Default value is 0.5.\u201d",
3382
- "default": 0.5,
3383
- "exclusiveMaximum": 1,
3384
- "minimum": 0,
3385
- "type": "number",
3386
- "format": "double"
3387
- },
3388
- "infrared_transmittance": {
3389
- "title": "Infrared Transmittance",
3390
- "description": "The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.",
3391
- "default": 0,
3392
- "exclusiveMaximum": 1,
3393
- "minimum": 0,
3394
- "type": "number",
3395
- "format": "double"
3396
- },
3397
- "emissivity": {
3398
- "title": "Emissivity",
3399
- "description": "Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
3400
- "default": 0.9,
3401
- "exclusiveMaximum": 1,
3402
- "minimum": 0,
3403
- "type": "number",
3404
- "format": "double"
3405
- },
3406
- "emissivity_back": {
3407
- "title": "Emissivity Back",
3408
- "description": "Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
3409
- "default": 0.9,
3410
- "exclusiveMaximum": 1,
3411
- "minimum": 0,
3412
- "type": "number",
3413
- "format": "double"
3414
- },
3415
- "distance_to_glass": {
3416
- "title": "Distance To Glass",
3417
- "description": "The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.",
3418
- "default": 0.05,
3419
- "minimum": 0.01,
3420
- "maximum": 1,
3421
- "type": "number",
3422
- "format": "double"
3423
- },
3424
- "top_opening_multiplier": {
3425
- "title": "Top Opening Multiplier",
3426
- "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. The default value is 0.5",
3427
- "default": 0.5,
3428
- "minimum": 0,
3429
- "maximum": 1,
3430
- "type": "number",
3431
- "format": "double"
3432
- },
3433
- "bottom_opening_multiplier": {
3434
- "title": "Bottom Opening Multiplier",
3435
- "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. The default value is 0.",
3436
- "default": 0.5,
3437
- "minimum": 0,
3438
- "maximum": 1,
3439
- "type": "number",
3440
- "format": "double"
3868
+ "type": {
3869
+ "title": "Type",
3870
+ "default": "ScheduleDay",
3871
+ "pattern": "^ScheduleDay$",
3872
+ "type": "string",
3873
+ "readOnly": true
3441
3874
  },
3442
- "left_opening_multiplier": {
3443
- "title": "Left Opening Multiplier",
3444
- "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
3445
- "default": 0.5,
3446
- "minimum": 0,
3447
- "maximum": 1,
3448
- "type": "number",
3449
- "format": "double"
3875
+ "times": {
3876
+ "title": "Times",
3877
+ "description": "A list of lists with each sub-list possesing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the \"time of beginning\" is a different convention than EnergyPlus, which uses \"time until\".",
3878
+ "default": [
3879
+ 0,
3880
+ 0
3881
+ ],
3882
+ "minItems": 2,
3883
+ "maxItems": 2,
3884
+ "type": "array",
3885
+ "items": {
3886
+ "type": "array",
3887
+ "items": {
3888
+ "type": "integer",
3889
+ "format": "int32"
3890
+ },
3891
+ "minItems": 2,
3892
+ "maxItems": 2
3893
+ }
3450
3894
  },
3451
- "right_opening_multiplier": {
3452
- "title": "Right Opening Multiplier",
3453
- "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
3454
- "default": 0.5,
3455
- "minimum": 0,
3456
- "maximum": 1,
3457
- "type": "number",
3458
- "format": "double"
3895
+ "interpolate": {
3896
+ "title": "Interpolate",
3897
+ "description": "Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
3898
+ "default": false,
3899
+ "type": "boolean"
3459
3900
  }
3460
3901
  },
3461
3902
  "required": [
3462
- "identifier"
3903
+ "identifier",
3904
+ "values"
3463
3905
  ],
3464
3906
  "additionalProperties": false
3465
3907
  },
3466
- "EnergyWindowMaterialGlazing": {
3467
- "title": "EnergyWindowMaterialGlazing",
3468
- "description": "Describe a single glass pane corresponding to a layer in a window construction.",
3908
+ "ScheduleRuleAbridged": {
3909
+ "title": "ScheduleRuleAbridged",
3910
+ "description": "Schedule rule including a ScheduleDay and when it should be applied..",
3469
3911
  "type": "object",
3470
3912
  "properties": {
3471
- "identifier": {
3472
- "title": "Identifier",
3473
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3913
+ "schedule_day": {
3914
+ "title": "Schedule Day",
3915
+ "description": "The identifier of a ScheduleDay object associated with this rule.",
3474
3916
  "maxLength": 100,
3475
3917
  "minLength": 1,
3476
3918
  "type": "string"
3477
3919
  },
3478
- "display_name": {
3479
- "title": "Display Name",
3480
- "description": "Display name of the object with no character restrictions.",
3481
- "type": "string"
3482
- },
3483
3920
  "type": {
3484
3921
  "title": "Type",
3485
- "default": "EnergyWindowMaterialGlazing",
3486
- "pattern": "^EnergyWindowMaterialGlazing$",
3922
+ "default": "ScheduleRuleAbridged",
3923
+ "pattern": "^ScheduleRuleAbridged$",
3487
3924
  "type": "string",
3488
3925
  "readOnly": true
3489
3926
  },
3490
- "thickness": {
3491
- "title": "Thickness",
3492
- "description": "The surface-to-surface of the glass in meters. Default value is 0.003.",
3493
- "default": 0.003,
3494
- "exclusiveMinimum": 0,
3495
- "type": "number",
3496
- "format": "double"
3927
+ "apply_sunday": {
3928
+ "title": "Apply Sunday",
3929
+ "description": "Boolean noting whether to apply schedule_day on Sundays.",
3930
+ "default": false,
3931
+ "type": "boolean"
3497
3932
  },
3498
- "solar_transmittance": {
3499
- "title": "Solar Transmittance",
3500
- "description": "Transmittance of solar radiation through the glass at normal incidence. Default value is 0.85 for clear glass.",
3501
- "default": 0.85,
3502
- "minimum": 0,
3503
- "maximum": 1,
3504
- "type": "number",
3505
- "format": "double"
3933
+ "apply_monday": {
3934
+ "title": "Apply Monday",
3935
+ "description": "Boolean noting whether to apply schedule_day on Mondays.",
3936
+ "default": false,
3937
+ "type": "boolean"
3506
3938
  },
3507
- "solar_reflectance": {
3508
- "title": "Solar Reflectance",
3509
- "description": "Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default value is 0.075 for clear glass.",
3510
- "default": 0.075,
3511
- "minimum": 0,
3512
- "maximum": 1,
3513
- "type": "number",
3514
- "format": "double"
3939
+ "apply_tuesday": {
3940
+ "title": "Apply Tuesday",
3941
+ "description": "Boolean noting whether to apply schedule_day on Tuesdays.",
3942
+ "default": false,
3943
+ "type": "boolean"
3515
3944
  },
3516
- "solar_reflectance_back": {
3517
- "title": "Solar Reflectance Back",
3518
- "description": "Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.",
3519
- "type": "number",
3520
- "format": "double"
3945
+ "apply_wednesday": {
3946
+ "title": "Apply Wednesday",
3947
+ "description": "Boolean noting whether to apply schedule_day on Wednesdays.",
3948
+ "default": false,
3949
+ "type": "boolean"
3521
3950
  },
3522
- "visible_transmittance": {
3523
- "title": "Visible Transmittance",
3524
- "description": "Transmittance of visible light through the glass at normal incidence. Default value is 0.9 for clear glass.",
3525
- "default": 0.9,
3526
- "minimum": 0,
3527
- "maximum": 1,
3528
- "type": "number",
3529
- "format": "double"
3951
+ "apply_thursday": {
3952
+ "title": "Apply Thursday",
3953
+ "description": "Boolean noting whether to apply schedule_day on Thursdays.",
3954
+ "default": false,
3955
+ "type": "boolean"
3530
3956
  },
3531
- "visible_reflectance": {
3532
- "title": "Visible Reflectance",
3533
- "description": "Reflectance of visible light off of the front side of the glass at normal incidence. Default value is 0.075 for clear glass.",
3534
- "default": 0.075,
3535
- "minimum": 0,
3536
- "maximum": 1,
3537
- "type": "number",
3538
- "format": "double"
3957
+ "apply_friday": {
3958
+ "title": "Apply Friday",
3959
+ "description": "Boolean noting whether to apply schedule_day on Fridays.",
3960
+ "default": false,
3961
+ "type": "boolean"
3539
3962
  },
3540
- "visible_reflectance_back": {
3541
- "title": "Visible Reflectance Back",
3542
- "description": "Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.",
3543
- "minimum": 0,
3544
- "maximum": 1,
3545
- "type": "number",
3546
- "format": "double"
3963
+ "apply_saturday": {
3964
+ "title": "Apply Saturday",
3965
+ "description": "Boolean noting whether to apply schedule_day on Saturdays.",
3966
+ "default": false,
3967
+ "type": "boolean"
3547
3968
  },
3548
- "infrared_transmittance": {
3549
- "title": "Infrared Transmittance",
3550
- "description": "Long-wave transmittance at normal incidence.",
3551
- "default": 0,
3552
- "minimum": 0,
3553
- "maximum": 1,
3554
- "type": "number",
3555
- "format": "double"
3969
+ "start_date": {
3970
+ "title": "Start Date",
3971
+ "description": "A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
3972
+ "default": [
3973
+ 1,
3974
+ 1
3975
+ ],
3976
+ "type": "array",
3977
+ "items": {
3978
+ "type": "integer",
3979
+ "format": "int32"
3980
+ },
3981
+ "minItems": 2,
3982
+ "maxItems": 3
3983
+ },
3984
+ "end_date": {
3985
+ "title": "End Date",
3986
+ "description": "A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
3987
+ "default": [
3988
+ 12,
3989
+ 31
3990
+ ],
3991
+ "type": "array",
3992
+ "items": {
3993
+ "type": "integer",
3994
+ "format": "int32"
3995
+ },
3996
+ "minItems": 2,
3997
+ "maxItems": 3
3998
+ }
3999
+ },
4000
+ "required": [
4001
+ "schedule_day"
4002
+ ],
4003
+ "additionalProperties": false
4004
+ },
4005
+ "NoLimit": {
4006
+ "title": "NoLimit",
4007
+ "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
4008
+ "type": "object",
4009
+ "properties": {
4010
+ "type": {
4011
+ "title": "Type",
4012
+ "default": "NoLimit",
4013
+ "pattern": "^NoLimit$",
4014
+ "type": "string",
4015
+ "readOnly": true
4016
+ }
4017
+ },
4018
+ "additionalProperties": false
4019
+ },
4020
+ "ScheduleTypeLimit": {
4021
+ "title": "ScheduleTypeLimit",
4022
+ "description": "Specifies the data types and limits for values contained in schedules.",
4023
+ "type": "object",
4024
+ "properties": {
4025
+ "identifier": {
4026
+ "title": "Identifier",
4027
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4028
+ "maxLength": 100,
4029
+ "minLength": 1,
4030
+ "type": "string"
3556
4031
  },
3557
- "emissivity": {
3558
- "title": "Emissivity",
3559
- "description": "Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3560
- "default": 0.84,
3561
- "minimum": 0,
3562
- "maximum": 1,
3563
- "type": "number",
3564
- "format": "double"
4032
+ "display_name": {
4033
+ "title": "Display Name",
4034
+ "description": "Display name of the object with no character restrictions.",
4035
+ "type": "string"
3565
4036
  },
3566
- "emissivity_back": {
3567
- "title": "Emissivity Back",
3568
- "description": "Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3569
- "default": 0.84,
3570
- "minimum": 0,
3571
- "maximum": 1,
3572
- "type": "number",
3573
- "format": "double"
4037
+ "type": {
4038
+ "title": "Type",
4039
+ "default": "ScheduleTypeLimit",
4040
+ "pattern": "^ScheduleTypeLimit$",
4041
+ "type": "string",
4042
+ "readOnly": true
3574
4043
  },
3575
- "conductivity": {
3576
- "title": "Conductivity",
3577
- "description": "Thermal conductivity of the glass in W/(m-K). Default value is 0.9, which is typical for clear glass without a low-e coating.",
3578
- "default": 0.9,
3579
- "exclusiveMinimum": 0,
3580
- "type": "number",
3581
- "format": "double"
4044
+ "lower_limit": {
4045
+ "title": "Lower Limit",
4046
+ "description": "Lower limit for the schedule type or NoLimit.",
4047
+ "default": {
4048
+ "type": "NoLimit"
4049
+ },
4050
+ "anyOf": [
4051
+ {
4052
+ "$ref": "#/components/schemas/NoLimit"
4053
+ },
4054
+ {
4055
+ "type": "number",
4056
+ "format": "double"
4057
+ }
4058
+ ]
3582
4059
  },
3583
- "dirt_correction": {
3584
- "title": "Dirt Correction",
3585
- "description": "Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.",
3586
- "default": 1,
3587
- "type": "number",
3588
- "format": "double"
4060
+ "upper_limit": {
4061
+ "title": "Upper Limit",
4062
+ "description": "Upper limit for the schedule type or NoLimit.",
4063
+ "default": {
4064
+ "type": "NoLimit"
4065
+ },
4066
+ "anyOf": [
4067
+ {
4068
+ "$ref": "#/components/schemas/NoLimit"
4069
+ },
4070
+ {
4071
+ "type": "number",
4072
+ "format": "double"
4073
+ }
4074
+ ]
3589
4075
  },
3590
- "solar_diffusing": {
3591
- "title": "Solar Diffusing",
3592
- "description": "Takes values True and False. If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.",
3593
- "default": false,
3594
- "type": "boolean"
4076
+ "numeric_type": {
4077
+ "allOf": [
4078
+ {
4079
+ "$ref": "#/components/schemas/ScheduleNumericType"
4080
+ }
4081
+ ],
4082
+ "title": "Numeric Type",
4083
+ "default": "Continuous",
4084
+ "type": "string"
4085
+ },
4086
+ "unit_type": {
4087
+ "allOf": [
4088
+ {
4089
+ "$ref": "#/components/schemas/ScheduleUnitType"
4090
+ }
4091
+ ],
4092
+ "title": "Unit Type",
4093
+ "default": "Dimensionless",
4094
+ "type": "string"
3595
4095
  }
3596
4096
  },
3597
4097
  "required": [
@@ -3599,9 +4099,9 @@
3599
4099
  ],
3600
4100
  "additionalProperties": false
3601
4101
  },
3602
- "EnergyWindowMaterialShade": {
3603
- "title": "EnergyWindowMaterialShade",
3604
- "description": "This object specifies the properties of window shade materials.",
4102
+ "ScheduleRuleset": {
4103
+ "title": "ScheduleRuleset",
4104
+ "description": "Used to define a schedule for a default day, further described by ScheduleRule.",
3605
4105
  "type": "object",
3606
4106
  "properties": {
3607
4107
  "identifier": {
@@ -3611,6 +4111,21 @@
3611
4111
  "minLength": 1,
3612
4112
  "type": "string"
3613
4113
  },
4114
+ "day_schedules": {
4115
+ "title": "Day Schedules",
4116
+ "description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
4117
+ "type": "array",
4118
+ "items": {
4119
+ "$ref": "#/components/schemas/ScheduleDay"
4120
+ }
4121
+ },
4122
+ "default_day_schedule": {
4123
+ "title": "Default Day Schedule",
4124
+ "description": "An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.",
4125
+ "maxLength": 100,
4126
+ "minLength": 1,
4127
+ "type": "string"
4128
+ },
3614
4129
  "display_name": {
3615
4130
  "title": "Display Name",
3616
4131
  "description": "Display name of the object with no character restrictions.",
@@ -3618,144 +4133,146 @@
3618
4133
  },
3619
4134
  "type": {
3620
4135
  "title": "Type",
3621
- "default": "EnergyWindowMaterialShade",
3622
- "pattern": "^EnergyWindowMaterialShade$",
4136
+ "default": "ScheduleRuleset",
4137
+ "pattern": "^ScheduleRuleset$",
3623
4138
  "type": "string",
3624
4139
  "readOnly": true
3625
4140
  },
3626
- "solar_transmittance": {
3627
- "title": "Solar Transmittance",
3628
- "description": "The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default value is 0.4.",
3629
- "default": 0.4,
3630
- "exclusiveMaximum": 1,
3631
- "minimum": 0,
3632
- "type": "number",
3633
- "format": "double"
3634
- },
3635
- "solar_reflectance": {
3636
- "title": "Solar Reflectance",
3637
- "description": "The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5",
3638
- "default": 0.5,
3639
- "exclusiveMaximum": 1,
3640
- "minimum": 0,
3641
- "type": "number",
3642
- "format": "double"
3643
- },
3644
- "visible_transmittance": {
3645
- "title": "Visible Transmittance",
3646
- "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4.",
3647
- "default": 0.4,
3648
- "exclusiveMaximum": 1,
3649
- "minimum": 0,
3650
- "type": "number",
3651
- "format": "double"
4141
+ "schedule_rules": {
4142
+ "title": "Schedule Rules",
4143
+ "description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
4144
+ "type": "array",
4145
+ "items": {
4146
+ "$ref": "#/components/schemas/ScheduleRuleAbridged"
4147
+ }
3652
4148
  },
3653
- "visible_reflectance": {
3654
- "title": "Visible Reflectance",
3655
- "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4",
3656
- "default": 0.4,
3657
- "exclusiveMaximum": 1,
3658
- "minimum": 0,
3659
- "type": "number",
3660
- "format": "double"
4149
+ "holiday_schedule": {
4150
+ "title": "Holiday Schedule",
4151
+ "description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
4152
+ "maxLength": 100,
4153
+ "minLength": 1,
4154
+ "type": "string"
3661
4155
  },
3662
- "emissivity": {
3663
- "title": "Emissivity",
3664
- "description": "The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default value is 0.9.",
3665
- "default": 0.9,
3666
- "exclusiveMinimum": 0,
3667
- "exclusiveMaximum": 1,
3668
- "type": "number",
3669
- "format": "double"
4156
+ "summer_designday_schedule": {
4157
+ "title": "Summer Designday Schedule",
4158
+ "description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
4159
+ "maxLength": 100,
4160
+ "minLength": 1,
4161
+ "type": "string"
3670
4162
  },
3671
- "infrared_transmittance": {
3672
- "title": "Infrared Transmittance",
3673
- "description": "The effective long-wave transmittance. It is assumed independent of incidence angle. Default value is 0.",
3674
- "default": 0,
3675
- "exclusiveMaximum": 1,
3676
- "minimum": 0,
3677
- "type": "number",
3678
- "format": "double"
4163
+ "winter_designday_schedule": {
4164
+ "title": "Winter Designday Schedule",
4165
+ "description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
4166
+ "maxLength": 100,
4167
+ "minLength": 1,
4168
+ "type": "string"
3679
4169
  },
3680
- "thickness": {
3681
- "title": "Thickness",
3682
- "description": "The thickness of the shade material in meters. Default value is 0.005.",
3683
- "default": 0.005,
3684
- "exclusiveMinimum": 0,
3685
- "type": "number",
3686
- "format": "double"
4170
+ "schedule_type_limit": {
4171
+ "title": "Schedule Type Limit",
4172
+ "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4173
+ "allOf": [
4174
+ {
4175
+ "$ref": "#/components/schemas/ScheduleTypeLimit"
4176
+ }
4177
+ ]
4178
+ }
4179
+ },
4180
+ "required": [
4181
+ "identifier",
4182
+ "day_schedules",
4183
+ "default_day_schedule"
4184
+ ],
4185
+ "additionalProperties": false
4186
+ },
4187
+ "ScheduleFixedInterval": {
4188
+ "title": "ScheduleFixedInterval",
4189
+ "description": "Used to specify a start date and a list of values for a period of analysis.",
4190
+ "type": "object",
4191
+ "properties": {
4192
+ "identifier": {
4193
+ "title": "Identifier",
4194
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4195
+ "maxLength": 100,
4196
+ "minLength": 1,
4197
+ "type": "string"
3687
4198
  },
3688
- "conductivity": {
3689
- "title": "Conductivity",
3690
- "description": "The conductivity of the shade material in W/(m-K). Default value is 0.1.",
3691
- "default": 0.1,
3692
- "exclusiveMinimum": 0,
3693
- "type": "number",
3694
- "format": "double"
4199
+ "values": {
4200
+ "title": "Values",
4201
+ "description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
4202
+ "type": "array",
4203
+ "items": {
4204
+ "type": "number",
4205
+ "format": "double"
4206
+ },
4207
+ "minItems": 24,
4208
+ "maxItems": 527040
3695
4209
  },
3696
- "distance_to_glass": {
3697
- "title": "Distance To Glass",
3698
- "description": "The distance from shade to adjacent glass in meters. Default value is 0.05",
3699
- "default": 0.05,
3700
- "minimum": 0.001,
3701
- "maximum": 1,
3702
- "type": "number",
3703
- "format": "double"
4210
+ "display_name": {
4211
+ "title": "Display Name",
4212
+ "description": "Display name of the object with no character restrictions.",
4213
+ "type": "string"
3704
4214
  },
3705
- "top_opening_multiplier": {
3706
- "title": "Top Opening Multiplier",
3707
- "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
3708
- "default": 0.5,
3709
- "minimum": 0,
3710
- "maximum": 1,
3711
- "type": "number",
3712
- "format": "double"
4215
+ "type": {
4216
+ "title": "Type",
4217
+ "default": "ScheduleFixedInterval",
4218
+ "pattern": "^ScheduleFixedInterval$",
4219
+ "type": "string",
4220
+ "readOnly": true
3713
4221
  },
3714
- "bottom_opening_multiplier": {
3715
- "title": "Bottom Opening Multiplier",
3716
- "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
3717
- "default": 0.5,
3718
- "minimum": 0,
3719
- "maximum": 1,
3720
- "type": "number",
3721
- "format": "double"
4222
+ "schedule_type_limit": {
4223
+ "title": "Schedule Type Limit",
4224
+ "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4225
+ "allOf": [
4226
+ {
4227
+ "$ref": "#/components/schemas/ScheduleTypeLimit"
4228
+ }
4229
+ ]
3722
4230
  },
3723
- "left_opening_multiplier": {
3724
- "title": "Left Opening Multiplier",
3725
- "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
3726
- "default": 0.5,
3727
- "minimum": 0,
3728
- "maximum": 1,
3729
- "type": "number",
3730
- "format": "double"
4231
+ "timestep": {
4232
+ "title": "Timestep",
4233
+ "description": "An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.",
4234
+ "default": 1,
4235
+ "type": "integer",
4236
+ "format": "int32"
3731
4237
  },
3732
- "right_opening_multiplier": {
3733
- "title": "Right Opening Multiplier",
3734
- "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
3735
- "default": 0.5,
3736
- "minimum": 0,
3737
- "maximum": 1,
3738
- "type": "number",
3739
- "format": "double"
4238
+ "start_date": {
4239
+ "title": "Start Date",
4240
+ "description": "A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4241
+ "default": [
4242
+ 1,
4243
+ 1
4244
+ ],
4245
+ "type": "array",
4246
+ "items": {
4247
+ "type": "integer",
4248
+ "format": "int32"
4249
+ },
4250
+ "minItems": 2,
4251
+ "maxItems": 3
3740
4252
  },
3741
- "airflow_permeability": {
3742
- "title": "Airflow Permeability",
3743
- "description": "The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default value is 0.",
4253
+ "placeholder_value": {
4254
+ "title": "Placeholder Value",
4255
+ "description": " A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.",
3744
4256
  "default": 0,
3745
- "minimum": 0,
3746
- "maximum": 0.8,
3747
4257
  "type": "number",
3748
4258
  "format": "double"
4259
+ },
4260
+ "interpolate": {
4261
+ "title": "Interpolate",
4262
+ "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
4263
+ "default": false,
4264
+ "type": "boolean"
3749
4265
  }
3750
4266
  },
3751
4267
  "required": [
3752
- "identifier"
4268
+ "identifier",
4269
+ "values"
3753
4270
  ],
3754
4271
  "additionalProperties": false
3755
4272
  },
3756
- "WindowConstruction": {
3757
- "title": "WindowConstruction",
3758
- "description": "Construction for window objects (Aperture, Door).",
4273
+ "AirBoundaryConstruction": {
4274
+ "title": "AirBoundaryConstruction",
4275
+ "description": "Construction for Air Boundary objects.",
3759
4276
  "type": "object",
3760
4277
  "properties": {
3761
4278
  "identifier": {
@@ -3765,51 +4282,17 @@
3765
4282
  "minLength": 1,
3766
4283
  "type": "string"
3767
4284
  },
3768
- "layers": {
3769
- "title": "Layers",
3770
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
3771
- "minLength": 1,
3772
- "maxLength": 100,
3773
- "type": "array",
3774
- "items": {
3775
- "type": "string",
3776
- "minLength": 1,
3777
- "maxLength": 100
3778
- },
3779
- "minItems": 1,
3780
- "maxItems": 8
3781
- },
3782
- "materials": {
3783
- "title": "Materials",
3784
- "description": "List of materials. The order of the materials is from outside to inside.",
3785
- "type": "array",
3786
- "items": {
3787
- "anyOf": [
3788
- {
3789
- "$ref": "#/components/schemas/EnergyWindowMaterialGas"
3790
- },
3791
- {
3792
- "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
3793
- },
3794
- {
3795
- "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
3796
- },
3797
- {
3798
- "$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
3799
- },
3800
- {
3801
- "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
3802
- },
3803
- {
3804
- "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
3805
- },
3806
- {
3807
- "$ref": "#/components/schemas/EnergyWindowMaterialShade"
3808
- }
3809
- ]
3810
- },
3811
- "minItems": 1,
3812
- "maxItems": 8
4285
+ "air_mixing_schedule": {
4286
+ "title": "Air Mixing Schedule",
4287
+ "description": "A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.",
4288
+ "anyOf": [
4289
+ {
4290
+ "$ref": "#/components/schemas/ScheduleRuleset"
4291
+ },
4292
+ {
4293
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
4294
+ }
4295
+ ]
3813
4296
  },
3814
4297
  "display_name": {
3815
4298
  "title": "Display Name",
@@ -3818,133 +4301,122 @@
3818
4301
  },
3819
4302
  "type": {
3820
4303
  "title": "Type",
3821
- "default": "WindowConstruction",
3822
- "pattern": "^WindowConstruction$",
4304
+ "default": "AirBoundaryConstruction",
4305
+ "pattern": "^AirBoundaryConstruction$",
3823
4306
  "type": "string",
3824
4307
  "readOnly": true
4308
+ },
4309
+ "air_mixing_per_area": {
4310
+ "title": "Air Mixing Per Area",
4311
+ "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4312
+ "default": 0.1,
4313
+ "minimum": 0,
4314
+ "type": "number",
4315
+ "format": "double"
3825
4316
  }
3826
4317
  },
3827
4318
  "required": [
3828
4319
  "identifier",
3829
- "layers",
3830
- "materials"
4320
+ "air_mixing_schedule"
3831
4321
  ],
3832
4322
  "additionalProperties": false
3833
4323
  },
3834
- "ApertureConstructionSet": {
3835
- "title": "ApertureConstructionSet",
3836
- "description": "A set of constructions for aperture assemblies.",
4324
+ "ConstructionSet": {
4325
+ "title": "ConstructionSet",
4326
+ "description": "A set of constructions for different surface types and boundary conditions.",
3837
4327
  "type": "object",
3838
4328
  "properties": {
4329
+ "identifier": {
4330
+ "title": "Identifier",
4331
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4332
+ "maxLength": 100,
4333
+ "minLength": 1,
4334
+ "type": "string"
4335
+ },
4336
+ "display_name": {
4337
+ "title": "Display Name",
4338
+ "description": "Display name of the object with no character restrictions.",
4339
+ "type": "string"
4340
+ },
3839
4341
  "type": {
3840
4342
  "title": "Type",
3841
- "default": "ApertureConstructionSet",
3842
- "pattern": "^ApertureConstructionSet$",
4343
+ "default": "ConstructionSet",
4344
+ "pattern": "^ConstructionSet$",
3843
4345
  "type": "string",
3844
4346
  "readOnly": true
3845
4347
  },
3846
- "interior_construction": {
3847
- "title": "Interior Construction",
3848
- "description": "A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
3849
- "allOf": [
3850
- {
3851
- "$ref": "#/components/schemas/WindowConstruction"
3852
- }
3853
- ]
3854
- },
3855
- "window_construction": {
3856
- "title": "Window Construction",
3857
- "description": "A WindowConstruction for all apertures with a Surface boundary condition.",
3858
- "allOf": [
3859
- {
3860
- "$ref": "#/components/schemas/WindowConstruction"
3861
- }
3862
- ]
3863
- },
3864
- "skylight_construction": {
3865
- "title": "Skylight Construction",
3866
- "description": "A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
4348
+ "wall_set": {
4349
+ "title": "Wall Set",
4350
+ "description": "A WallConstructionSet object for this ConstructionSet.",
3867
4351
  "allOf": [
3868
4352
  {
3869
- "$ref": "#/components/schemas/WindowConstruction"
4353
+ "$ref": "#/components/schemas/WallConstructionSet"
3870
4354
  }
3871
4355
  ]
3872
4356
  },
3873
- "operable_construction": {
3874
- "title": "Operable Construction",
3875
- "description": "A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property..",
4357
+ "floor_set": {
4358
+ "title": "Floor Set",
4359
+ "description": "A FloorConstructionSet object for this ConstructionSet.",
3876
4360
  "allOf": [
3877
4361
  {
3878
- "$ref": "#/components/schemas/WindowConstruction"
4362
+ "$ref": "#/components/schemas/FloorConstructionSet"
3879
4363
  }
3880
4364
  ]
3881
- }
3882
- },
3883
- "additionalProperties": false
3884
- },
3885
- "DoorConstructionSet": {
3886
- "title": "DoorConstructionSet",
3887
- "description": "A set of constructions for door assemblies.",
3888
- "type": "object",
3889
- "properties": {
3890
- "type": {
3891
- "title": "Type",
3892
- "default": "DoorConstructionSet",
3893
- "pattern": "^DoorConstructionSet$",
3894
- "type": "string",
3895
- "readOnly": true
3896
4365
  },
3897
- "interior_construction": {
3898
- "title": "Interior Construction",
3899
- "description": "An OpaqueConstruction for all opaque doors with a Surface boundary condition.",
4366
+ "roof_ceiling_set": {
4367
+ "title": "Roof Ceiling Set",
4368
+ "description": "A RoofCeilingConstructionSet object for this ConstructionSet.",
3900
4369
  "allOf": [
3901
4370
  {
3902
- "$ref": "#/components/schemas/OpaqueConstruction"
4371
+ "$ref": "#/components/schemas/RoofCeilingConstructionSet"
3903
4372
  }
3904
4373
  ]
3905
4374
  },
3906
- "exterior_construction": {
3907
- "title": "Exterior Construction",
3908
- "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
4375
+ "aperture_set": {
4376
+ "title": "Aperture Set",
4377
+ "description": "A ApertureConstructionSet object for this ConstructionSet.",
3909
4378
  "allOf": [
3910
4379
  {
3911
- "$ref": "#/components/schemas/OpaqueConstruction"
4380
+ "$ref": "#/components/schemas/ApertureConstructionSet"
3912
4381
  }
3913
4382
  ]
3914
4383
  },
3915
- "overhead_construction": {
3916
- "title": "Overhead Construction",
3917
- "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
4384
+ "door_set": {
4385
+ "title": "Door Set",
4386
+ "description": "A DoorConstructionSet object for this ConstructionSet.",
3918
4387
  "allOf": [
3919
4388
  {
3920
- "$ref": "#/components/schemas/OpaqueConstruction"
4389
+ "$ref": "#/components/schemas/DoorConstructionSet"
3921
4390
  }
3922
4391
  ]
3923
4392
  },
3924
- "exterior_glass_construction": {
3925
- "title": "Exterior Glass Construction",
3926
- "description": "A WindowConstruction for all glass doors with an Outdoors boundary condition.",
4393
+ "shade_construction": {
4394
+ "title": "Shade Construction",
4395
+ "description": "A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
3927
4396
  "allOf": [
3928
4397
  {
3929
- "$ref": "#/components/schemas/WindowConstruction"
4398
+ "$ref": "#/components/schemas/ShadeConstruction"
3930
4399
  }
3931
4400
  ]
3932
4401
  },
3933
- "interior_glass_construction": {
3934
- "title": "Interior Glass Construction",
3935
- "description": "A WindowConstruction for all glass doors with a Surface boundary condition.",
4402
+ "air_boundary_construction": {
4403
+ "title": "Air Boundary Construction",
4404
+ "description": "An AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.",
3936
4405
  "allOf": [
3937
4406
  {
3938
- "$ref": "#/components/schemas/WindowConstruction"
4407
+ "$ref": "#/components/schemas/AirBoundaryConstruction"
3939
4408
  }
3940
4409
  ]
3941
4410
  }
3942
4411
  },
4412
+ "required": [
4413
+ "identifier"
4414
+ ],
3943
4415
  "additionalProperties": false
3944
4416
  },
3945
- "ShadeConstruction": {
3946
- "title": "ShadeConstruction",
3947
- "description": "Construction for Shade objects.",
4417
+ "OpaqueConstructionAbridged": {
4418
+ "title": "OpaqueConstructionAbridged",
4419
+ "description": "Construction for opaque objects (Face, Shade, Door).",
3948
4420
  "type": "object",
3949
4421
  "properties": {
3950
4422
  "identifier": {
@@ -3954,6 +4426,20 @@
3954
4426
  "minLength": 1,
3955
4427
  "type": "string"
3956
4428
  },
4429
+ "layers": {
4430
+ "title": "Layers",
4431
+ "description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
4432
+ "minLength": 1,
4433
+ "maxLength": 100,
4434
+ "type": "array",
4435
+ "items": {
4436
+ "type": "string",
4437
+ "minLength": 1,
4438
+ "maxLength": 100
4439
+ },
4440
+ "minItems": 1,
4441
+ "maxItems": 10
4442
+ },
3957
4443
  "display_name": {
3958
4444
  "title": "Display Name",
3959
4445
  "description": "Display name of the object with no character restrictions.",
@@ -3961,44 +4447,21 @@
3961
4447
  },
3962
4448
  "type": {
3963
4449
  "title": "Type",
3964
- "default": "ShadeConstruction",
3965
- "pattern": "^ShadeConstruction$",
4450
+ "default": "OpaqueConstructionAbridged",
4451
+ "pattern": "^OpaqueConstructionAbridged$",
3966
4452
  "type": "string",
3967
4453
  "readOnly": true
3968
- },
3969
- "solar_reflectance": {
3970
- "title": "Solar Reflectance",
3971
- "description": " A number for the solar reflectance of the construction.",
3972
- "default": 0.2,
3973
- "minimum": 0,
3974
- "maximum": 1,
3975
- "type": "number",
3976
- "format": "double"
3977
- },
3978
- "visible_reflectance": {
3979
- "title": "Visible Reflectance",
3980
- "description": " A number for the visible reflectance of the construction.",
3981
- "default": 0.2,
3982
- "minimum": 0,
3983
- "maximum": 1,
3984
- "type": "number",
3985
- "format": "double"
3986
- },
3987
- "is_specular": {
3988
- "title": "Is Specular",
3989
- "description": "Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.",
3990
- "default": false,
3991
- "type": "boolean"
3992
4454
  }
3993
4455
  },
3994
4456
  "required": [
3995
- "identifier"
4457
+ "identifier",
4458
+ "layers"
3996
4459
  ],
3997
4460
  "additionalProperties": false
3998
4461
  },
3999
- "ScheduleDay": {
4000
- "title": "ScheduleDay",
4001
- "description": "Used to describe the daily schedule for a single simulation day.",
4462
+ "WindowConstructionAbridged": {
4463
+ "title": "WindowConstructionAbridged",
4464
+ "description": "Construction for window objects (Aperture, Door).",
4002
4465
  "type": "object",
4003
4466
  "properties": {
4004
4467
  "identifier": {
@@ -4008,14 +4471,19 @@
4008
4471
  "minLength": 1,
4009
4472
  "type": "string"
4010
4473
  },
4011
- "values": {
4012
- "title": "Values",
4013
- "description": "A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.",
4474
+ "layers": {
4475
+ "title": "Layers",
4476
+ "description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
4477
+ "minLength": 1,
4478
+ "maxLength": 100,
4014
4479
  "type": "array",
4015
4480
  "items": {
4016
- "type": "number",
4017
- "format": "double"
4018
- }
4481
+ "type": "string",
4482
+ "minLength": 1,
4483
+ "maxLength": 100
4484
+ },
4485
+ "minItems": 1,
4486
+ "maxItems": 8
4019
4487
  },
4020
4488
  "display_name": {
4021
4489
  "title": "Display Name",
@@ -4024,159 +4492,112 @@
4024
4492
  },
4025
4493
  "type": {
4026
4494
  "title": "Type",
4027
- "default": "ScheduleDay",
4028
- "pattern": "^ScheduleDay$",
4495
+ "default": "WindowConstructionAbridged",
4496
+ "pattern": "^WindowConstructionAbridged$",
4029
4497
  "type": "string",
4030
4498
  "readOnly": true
4031
- },
4032
- "times": {
4033
- "title": "Times",
4034
- "description": "A list of lists with each sub-list possesing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the \"time of beginning\" is a different convention than EnergyPlus, which uses \"time until\".",
4035
- "default": [
4036
- 0,
4037
- 0
4038
- ],
4039
- "minItems": 2,
4040
- "maxItems": 2,
4041
- "type": "array",
4042
- "items": {
4043
- "type": "array",
4044
- "items": {
4045
- "type": "integer",
4046
- "format": "int32"
4047
- },
4048
- "minItems": 2,
4049
- "maxItems": 2
4050
- }
4051
- },
4052
- "interpolate": {
4053
- "title": "Interpolate",
4054
- "description": "Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corrsponding to them.",
4055
- "default": false,
4056
- "type": "boolean"
4057
4499
  }
4058
4500
  },
4059
4501
  "required": [
4060
4502
  "identifier",
4061
- "values"
4503
+ "layers"
4062
4504
  ],
4063
4505
  "additionalProperties": false
4064
4506
  },
4065
- "ScheduleRuleAbridged": {
4066
- "title": "ScheduleRuleAbridged",
4067
- "description": "Schedule rule including a ScheduleDay and when it should be applied..",
4507
+ "WindowConstructionShadeAbridged": {
4508
+ "title": "WindowConstructionShadeAbridged",
4509
+ "description": "Construction for window objects with an included shade layer.",
4068
4510
  "type": "object",
4069
4511
  "properties": {
4070
- "schedule_day": {
4071
- "title": "Schedule Day",
4072
- "description": "The identifier of a ScheduleDay object associated with this rule.",
4512
+ "identifier": {
4513
+ "title": "Identifier",
4514
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4515
+ "maxLength": 100,
4516
+ "minLength": 1,
4517
+ "type": "string"
4518
+ },
4519
+ "window_construction": {
4520
+ "title": "Window Construction",
4521
+ "description": "A WindowConstructionAbridged object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction.",
4522
+ "allOf": [
4523
+ {
4524
+ "$ref": "#/components/schemas/WindowConstructionAbridged"
4525
+ }
4526
+ ]
4527
+ },
4528
+ "shade_material": {
4529
+ "title": "Shade Material",
4530
+ "description": "Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.",
4073
4531
  "maxLength": 100,
4074
4532
  "minLength": 1,
4075
4533
  "type": "string"
4076
4534
  },
4535
+ "display_name": {
4536
+ "title": "Display Name",
4537
+ "description": "Display name of the object with no character restrictions.",
4538
+ "type": "string"
4539
+ },
4077
4540
  "type": {
4078
4541
  "title": "Type",
4079
- "default": "ScheduleRuleAbridged",
4080
- "pattern": "^ScheduleRuleAbridged$",
4542
+ "default": "WindowConstructionShadeAbridged",
4543
+ "pattern": "^WindowConstructionShadeAbridged$",
4081
4544
  "type": "string",
4082
4545
  "readOnly": true
4083
4546
  },
4084
- "apply_sunday": {
4085
- "title": "Apply Sunday",
4086
- "description": "Boolean noting whether to apply schedule_day on Sundays.",
4087
- "default": false,
4088
- "type": "boolean"
4089
- },
4090
- "apply_monday": {
4091
- "title": "Apply Monday",
4092
- "description": "Boolean noting whether to apply schedule_day on Mondays.",
4093
- "default": false,
4094
- "type": "boolean"
4095
- },
4096
- "apply_tuesday": {
4097
- "title": "Apply Tuesday",
4098
- "description": "Boolean noting whether to apply schedule_day on Tuesdays.",
4099
- "default": false,
4100
- "type": "boolean"
4101
- },
4102
- "apply_wednesday": {
4103
- "title": "Apply Wednesday",
4104
- "description": "Boolean noting whether to apply schedule_day on Wednesdays.",
4105
- "default": false,
4106
- "type": "boolean"
4107
- },
4108
- "apply_thursday": {
4109
- "title": "Apply Thursday",
4110
- "description": "Boolean noting whether to apply schedule_day on Thursdays.",
4111
- "default": false,
4112
- "type": "boolean"
4113
- },
4114
- "apply_friday": {
4115
- "title": "Apply Friday",
4116
- "description": "Boolean noting whether to apply schedule_day on Fridays.",
4117
- "default": false,
4118
- "type": "boolean"
4119
- },
4120
- "apply_saturday": {
4121
- "title": "Apply Saturday",
4122
- "description": "Boolean noting whether to apply schedule_day on Saturdays.",
4123
- "default": false,
4124
- "type": "boolean"
4125
- },
4126
- "start_date": {
4127
- "title": "Start Date",
4128
- "description": "A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4129
- "default": [
4130
- 1,
4131
- 1
4547
+ "shade_location": {
4548
+ "allOf": [
4549
+ {
4550
+ "$ref": "#/components/schemas/ShadeLocation"
4551
+ }
4132
4552
  ],
4133
- "type": "array",
4134
- "items": {
4135
- "type": "integer",
4136
- "format": "int32"
4137
- },
4138
- "minItems": 2,
4139
- "maxItems": 3
4553
+ "title": "Shade Location",
4554
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
4555
+ "default": "Interior",
4556
+ "type": "string"
4140
4557
  },
4141
- "end_date": {
4142
- "title": "End Date",
4143
- "description": "A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4144
- "default": [
4145
- 12,
4146
- 31
4558
+ "control_type": {
4559
+ "allOf": [
4560
+ {
4561
+ "$ref": "#/components/schemas/ControlType"
4562
+ }
4147
4563
  ],
4148
- "type": "array",
4149
- "items": {
4150
- "type": "integer",
4151
- "format": "int32"
4152
- },
4153
- "minItems": 2,
4154
- "maxItems": 3
4564
+ "title": "Control Type",
4565
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
4566
+ "default": "AlwaysOn",
4567
+ "type": "string"
4568
+ },
4569
+ "setpoint": {
4570
+ "title": "Setpoint",
4571
+ "description": "A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except \"AlwaysOn.\"",
4572
+ "type": "number",
4573
+ "format": "double"
4574
+ },
4575
+ "schedule": {
4576
+ "title": "Schedule",
4577
+ "description": "An optional schedule identifier to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.",
4578
+ "maxLength": 100,
4579
+ "minLength": 1,
4580
+ "type": "string",
4581
+ "anyOf": [
4582
+ {
4583
+ "$ref": "#/components/schemas/ScheduleRuleset"
4584
+ },
4585
+ {
4586
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
4587
+ }
4588
+ ]
4155
4589
  }
4156
4590
  },
4157
4591
  "required": [
4158
- "schedule_day"
4592
+ "identifier",
4593
+ "window_construction",
4594
+ "shade_material"
4159
4595
  ],
4160
4596
  "additionalProperties": false
4161
4597
  },
4162
- "NoLimit": {
4163
- "title": "NoLimit",
4164
- "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
4165
- "type": "object",
4166
- "properties": {
4167
- "type": {
4168
- "title": "Type",
4169
- "default": "NoLimit",
4170
- "pattern": "^NoLimit$",
4171
- "type": "string",
4172
- "readOnly": true
4173
- }
4174
- },
4175
- "additionalProperties": false
4176
- },
4177
- "ScheduleTypeLimit": {
4178
- "title": "ScheduleTypeLimit",
4179
- "description": "Specifies the data types and limits for values contained in schedules.",
4598
+ "AirBoundaryConstructionAbridged": {
4599
+ "title": "AirBoundaryConstructionAbridged",
4600
+ "description": "Construction for Air Boundary objects.",
4180
4601
  "type": "object",
4181
4602
  "properties": {
4182
4603
  "identifier": {
@@ -4186,6 +4607,13 @@
4186
4607
  "minLength": 1,
4187
4608
  "type": "string"
4188
4609
  },
4610
+ "air_mixing_schedule": {
4611
+ "title": "Air Mixing Schedule",
4612
+ "description": "Identifier of a fractional schedule for the air mixing schedule across the construction.",
4613
+ "maxLength": 100,
4614
+ "minLength": 1,
4615
+ "type": "string"
4616
+ },
4189
4617
  "display_name": {
4190
4618
  "title": "Display Name",
4191
4619
  "description": "Display name of the object with no character restrictions.",
@@ -4193,82 +4621,29 @@
4193
4621
  },
4194
4622
  "type": {
4195
4623
  "title": "Type",
4196
- "default": "ScheduleTypeLimit",
4197
- "pattern": "^ScheduleTypeLimit$",
4624
+ "default": "AirBoundaryConstructionAbridged",
4625
+ "pattern": "^AirBoundaryConstructionAbridged$",
4198
4626
  "type": "string",
4199
4627
  "readOnly": true
4200
4628
  },
4201
- "lower_limit": {
4202
- "title": "Lower Limit",
4203
- "description": "Lower limit for the schedule type or NoLimit.",
4204
- "default": {
4205
- "type": "NoLimit"
4206
- },
4207
- "anyOf": [
4208
- {
4209
- "$ref": "#/components/schemas/NoLimit"
4210
- },
4211
- {
4212
- "type": "number",
4213
- "format": "double"
4214
- }
4215
- ]
4216
- },
4217
- "upper_limit": {
4218
- "title": "Upper Limit",
4219
- "description": "Upper limit for the schedule type or NoLimit.",
4220
- "default": {
4221
- "type": "NoLimit"
4222
- },
4223
- "anyOf": [
4224
- {
4225
- "$ref": "#/components/schemas/NoLimit"
4226
- },
4227
- {
4228
- "type": "number",
4229
- "format": "double"
4230
- }
4231
- ]
4232
- },
4233
- "numeric_type": {
4234
- "title": "Numeric Type",
4235
- "default": "Continuous",
4236
- "enum": [
4237
- "Continuous",
4238
- "Discrete"
4239
- ],
4240
- "type": "string"
4241
- },
4242
- "unit_type": {
4243
- "title": "Unit Type",
4244
- "default": "Dimensionless",
4245
- "enum": [
4246
- "Dimensionless",
4247
- "Temperature",
4248
- "DeltaTemperature",
4249
- "PrecipitationRate",
4250
- "Angle",
4251
- "ConvectionCoefficient",
4252
- "ActivityLevel",
4253
- "Velocity",
4254
- "Capacity",
4255
- "Power",
4256
- "Availability",
4257
- "Percent",
4258
- "Control",
4259
- "Mode"
4260
- ],
4261
- "type": "string"
4629
+ "air_mixing_per_area": {
4630
+ "title": "Air Mixing Per Area",
4631
+ "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4632
+ "default": 0.1,
4633
+ "minimum": 0,
4634
+ "type": "number",
4635
+ "format": "double"
4262
4636
  }
4263
4637
  },
4264
4638
  "required": [
4265
- "identifier"
4639
+ "identifier",
4640
+ "air_mixing_schedule"
4266
4641
  ],
4267
4642
  "additionalProperties": false
4268
4643
  },
4269
- "ScheduleRuleset": {
4270
- "title": "ScheduleRuleset",
4271
- "description": "Used to define a schedule for a default day, further described by ScheduleRule.",
4644
+ "EnergyWindowMaterialShade": {
4645
+ "title": "EnergyWindowMaterialShade",
4646
+ "description": "This object specifies the properties of window shade materials.",
4272
4647
  "type": "object",
4273
4648
  "properties": {
4274
4649
  "identifier": {
@@ -4278,21 +4653,6 @@
4278
4653
  "minLength": 1,
4279
4654
  "type": "string"
4280
4655
  },
4281
- "day_schedules": {
4282
- "title": "Day Schedules",
4283
- "description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
4284
- "type": "array",
4285
- "items": {
4286
- "$ref": "#/components/schemas/ScheduleDay"
4287
- }
4288
- },
4289
- "default_day_schedule": {
4290
- "title": "Default Day Schedule",
4291
- "description": "An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.",
4292
- "maxLength": 100,
4293
- "minLength": 1,
4294
- "type": "string"
4295
- },
4296
4656
  "display_name": {
4297
4657
  "title": "Display Name",
4298
4658
  "description": "Display name of the object with no character restrictions.",
@@ -4300,60 +4660,144 @@
4300
4660
  },
4301
4661
  "type": {
4302
4662
  "title": "Type",
4303
- "default": "ScheduleRuleset",
4304
- "pattern": "^ScheduleRuleset$",
4663
+ "default": "EnergyWindowMaterialShade",
4664
+ "pattern": "^EnergyWindowMaterialShade$",
4305
4665
  "type": "string",
4306
4666
  "readOnly": true
4307
4667
  },
4308
- "schedule_rules": {
4309
- "title": "Schedule Rules",
4310
- "description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
4311
- "type": "array",
4312
- "items": {
4313
- "$ref": "#/components/schemas/ScheduleRuleAbridged"
4314
- }
4668
+ "solar_transmittance": {
4669
+ "title": "Solar Transmittance",
4670
+ "description": "The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default value is 0.4.",
4671
+ "default": 0.4,
4672
+ "exclusiveMaximum": 1,
4673
+ "minimum": 0,
4674
+ "type": "number",
4675
+ "format": "double"
4315
4676
  },
4316
- "holiday_schedule": {
4317
- "title": "Holiday Schedule",
4318
- "description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
4319
- "maxLength": 100,
4320
- "minLength": 1,
4321
- "type": "string"
4677
+ "solar_reflectance": {
4678
+ "title": "Solar Reflectance",
4679
+ "description": "The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5",
4680
+ "default": 0.5,
4681
+ "exclusiveMaximum": 1,
4682
+ "minimum": 0,
4683
+ "type": "number",
4684
+ "format": "double"
4322
4685
  },
4323
- "summer_designday_schedule": {
4324
- "title": "Summer Designday Schedule",
4325
- "description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
4326
- "maxLength": 100,
4327
- "minLength": 1,
4328
- "type": "string"
4686
+ "visible_transmittance": {
4687
+ "title": "Visible Transmittance",
4688
+ "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4.",
4689
+ "default": 0.4,
4690
+ "exclusiveMaximum": 1,
4691
+ "minimum": 0,
4692
+ "type": "number",
4693
+ "format": "double"
4329
4694
  },
4330
- "winter_designday_schedule": {
4331
- "title": "Winter Designday Schedule",
4332
- "description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
4333
- "maxLength": 100,
4334
- "minLength": 1,
4335
- "type": "string"
4695
+ "visible_reflectance": {
4696
+ "title": "Visible Reflectance",
4697
+ "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4",
4698
+ "default": 0.4,
4699
+ "exclusiveMaximum": 1,
4700
+ "minimum": 0,
4701
+ "type": "number",
4702
+ "format": "double"
4336
4703
  },
4337
- "schedule_type_limit": {
4338
- "title": "Schedule Type Limit",
4339
- "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4340
- "allOf": [
4341
- {
4342
- "$ref": "#/components/schemas/ScheduleTypeLimit"
4343
- }
4344
- ]
4704
+ "emissivity": {
4705
+ "title": "Emissivity",
4706
+ "description": "The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default value is 0.9.",
4707
+ "default": 0.9,
4708
+ "exclusiveMinimum": 0,
4709
+ "exclusiveMaximum": 1,
4710
+ "type": "number",
4711
+ "format": "double"
4712
+ },
4713
+ "infrared_transmittance": {
4714
+ "title": "Infrared Transmittance",
4715
+ "description": "The effective long-wave transmittance. It is assumed independent of incidence angle. Default value is 0.",
4716
+ "default": 0,
4717
+ "exclusiveMaximum": 1,
4718
+ "minimum": 0,
4719
+ "type": "number",
4720
+ "format": "double"
4721
+ },
4722
+ "thickness": {
4723
+ "title": "Thickness",
4724
+ "description": "The thickness of the shade material in meters. Default value is 0.005.",
4725
+ "default": 0.005,
4726
+ "exclusiveMinimum": 0,
4727
+ "type": "number",
4728
+ "format": "double"
4729
+ },
4730
+ "conductivity": {
4731
+ "title": "Conductivity",
4732
+ "description": "The conductivity of the shade material in W/(m-K). Default value is 0.1.",
4733
+ "default": 0.1,
4734
+ "exclusiveMinimum": 0,
4735
+ "type": "number",
4736
+ "format": "double"
4737
+ },
4738
+ "distance_to_glass": {
4739
+ "title": "Distance To Glass",
4740
+ "description": "The distance from shade to adjacent glass in meters. Default value is 0.05",
4741
+ "default": 0.05,
4742
+ "minimum": 0.001,
4743
+ "maximum": 1,
4744
+ "type": "number",
4745
+ "format": "double"
4746
+ },
4747
+ "top_opening_multiplier": {
4748
+ "title": "Top Opening Multiplier",
4749
+ "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
4750
+ "default": 0.5,
4751
+ "minimum": 0,
4752
+ "maximum": 1,
4753
+ "type": "number",
4754
+ "format": "double"
4755
+ },
4756
+ "bottom_opening_multiplier": {
4757
+ "title": "Bottom Opening Multiplier",
4758
+ "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
4759
+ "default": 0.5,
4760
+ "minimum": 0,
4761
+ "maximum": 1,
4762
+ "type": "number",
4763
+ "format": "double"
4764
+ },
4765
+ "left_opening_multiplier": {
4766
+ "title": "Left Opening Multiplier",
4767
+ "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
4768
+ "default": 0.5,
4769
+ "minimum": 0,
4770
+ "maximum": 1,
4771
+ "type": "number",
4772
+ "format": "double"
4773
+ },
4774
+ "right_opening_multiplier": {
4775
+ "title": "Right Opening Multiplier",
4776
+ "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
4777
+ "default": 0.5,
4778
+ "minimum": 0,
4779
+ "maximum": 1,
4780
+ "type": "number",
4781
+ "format": "double"
4782
+ },
4783
+ "airflow_permeability": {
4784
+ "title": "Airflow Permeability",
4785
+ "description": "The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default value is 0.",
4786
+ "default": 0,
4787
+ "minimum": 0,
4788
+ "maximum": 0.8,
4789
+ "type": "number",
4790
+ "format": "double"
4345
4791
  }
4346
4792
  },
4347
4793
  "required": [
4348
- "identifier",
4349
- "day_schedules",
4350
- "default_day_schedule"
4794
+ "identifier"
4351
4795
  ],
4352
4796
  "additionalProperties": false
4353
4797
  },
4354
- "ScheduleFixedInterval": {
4355
- "title": "ScheduleFixedInterval",
4356
- "description": "Used to specify a start date and a list of values for a period of analysis.",
4798
+ "EnergyWindowMaterialBlind": {
4799
+ "title": "EnergyWindowMaterialBlind",
4800
+ "description": "Window blind material consisting of flat, equally-spaced slats.",
4357
4801
  "type": "object",
4358
4802
  "properties": {
4359
4803
  "identifier": {
@@ -4363,17 +4807,6 @@
4363
4807
  "minLength": 1,
4364
4808
  "type": "string"
4365
4809
  },
4366
- "values": {
4367
- "title": "Values",
4368
- "description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
4369
- "type": "array",
4370
- "items": {
4371
- "type": "number",
4372
- "format": "double"
4373
- },
4374
- "minItems": 24,
4375
- "maxItems": 527040
4376
- },
4377
4810
  "display_name": {
4378
4811
  "title": "Display Name",
4379
4812
  "description": "Display name of the object with no character restrictions.",
@@ -4381,116 +4814,254 @@
4381
4814
  },
4382
4815
  "type": {
4383
4816
  "title": "Type",
4384
- "default": "ScheduleFixedInterval",
4385
- "pattern": "^ScheduleFixedInterval$",
4817
+ "default": "EnergyWindowMaterialBlind",
4818
+ "pattern": "^EnergyWindowMaterialBlind$",
4386
4819
  "type": "string",
4387
4820
  "readOnly": true
4388
4821
  },
4389
- "schedule_type_limit": {
4390
- "title": "Schedule Type Limit",
4391
- "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4822
+ "slat_orientation": {
4392
4823
  "allOf": [
4393
4824
  {
4394
- "$ref": "#/components/schemas/ScheduleTypeLimit"
4825
+ "$ref": "#/components/schemas/SlatOrientation"
4395
4826
  }
4396
- ]
4827
+ ],
4828
+ "title": "Slat Orientation",
4829
+ "default": "Horizontal",
4830
+ "type": "string"
4397
4831
  },
4398
- "timestep": {
4399
- "title": "Timestep",
4400
- "description": "An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.",
4401
- "default": 1,
4402
- "type": "integer",
4403
- "format": "int32"
4832
+ "slat_width": {
4833
+ "title": "Slat Width",
4834
+ "description": "The width of slat measured from edge to edge in meters.",
4835
+ "default": 0.025,
4836
+ "exclusiveMinimum": 0,
4837
+ "maximum": 1,
4838
+ "type": "number",
4839
+ "format": "double"
4404
4840
  },
4405
- "start_date": {
4406
- "title": "Start Date",
4407
- "description": "A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4408
- "default": [
4409
- 1,
4410
- 1
4411
- ],
4412
- "type": "array",
4413
- "items": {
4414
- "type": "integer",
4415
- "format": "int32"
4416
- },
4417
- "minItems": 2,
4418
- "maxItems": 3
4841
+ "slat_separation": {
4842
+ "title": "Slat Separation",
4843
+ "description": "The distance between the front of a slat and the back of the adjacent slat in meters.",
4844
+ "default": 0.01875,
4845
+ "exclusiveMinimum": 0,
4846
+ "maximum": 1,
4847
+ "type": "number",
4848
+ "format": "double"
4419
4849
  },
4420
- "placeholder_value": {
4421
- "title": "Placeholder Value",
4422
- "description": " A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.",
4850
+ "slat_thickness": {
4851
+ "title": "Slat Thickness",
4852
+ "description": "The distance between the faces of a slat in meters. The default value is 0.001.",
4853
+ "default": 0.001,
4854
+ "exclusiveMinimum": 0,
4855
+ "maximum": 0.1,
4856
+ "type": "number",
4857
+ "format": "double"
4858
+ },
4859
+ "slat_angle": {
4860
+ "title": "Slat Angle",
4861
+ "description": "The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.",
4862
+ "default": 45,
4863
+ "minimum": 0,
4864
+ "maximum": 180,
4865
+ "type": "number",
4866
+ "format": "double"
4867
+ },
4868
+ "slat_conductivity": {
4869
+ "title": "Slat Conductivity",
4870
+ "description": "The thermal conductivity of the slat in W/(m-K). Default value is 221.",
4871
+ "default": 221,
4872
+ "exclusiveMinimum": 0,
4873
+ "type": "number",
4874
+ "format": "double"
4875
+ },
4876
+ "beam_solar_transmittance": {
4877
+ "title": "Beam Solar Transmittance",
4878
+ "description": "The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.",
4423
4879
  "default": 0,
4880
+ "exclusiveMaximum": 1,
4881
+ "minimum": 0,
4424
4882
  "type": "number",
4425
4883
  "format": "double"
4426
4884
  },
4427
- "interpolate": {
4428
- "title": "Interpolate",
4429
- "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corrsponding to them.",
4430
- "default": false,
4431
- "type": "boolean"
4432
- }
4433
- },
4434
- "required": [
4435
- "identifier",
4436
- "values"
4437
- ],
4438
- "additionalProperties": false
4439
- },
4440
- "AirBoundaryConstruction": {
4441
- "title": "AirBoundaryConstruction",
4442
- "description": "Construction for Air Boundary objects.",
4443
- "type": "object",
4444
- "properties": {
4445
- "identifier": {
4446
- "title": "Identifier",
4447
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4448
- "maxLength": 100,
4449
- "minLength": 1,
4450
- "type": "string"
4885
+ "beam_solar_reflectance": {
4886
+ "title": "Beam Solar Reflectance",
4887
+ "description": "The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4888
+ "default": 0.5,
4889
+ "exclusiveMaximum": 1,
4890
+ "minimum": 0,
4891
+ "type": "number",
4892
+ "format": "double"
4451
4893
  },
4452
- "air_mixing_schedule": {
4453
- "title": "Air Mixing Schedule",
4454
- "description": "A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.",
4455
- "anyOf": [
4456
- {
4457
- "$ref": "#/components/schemas/ScheduleRuleset"
4458
- },
4459
- {
4460
- "$ref": "#/components/schemas/ScheduleFixedInterval"
4461
- }
4462
- ]
4894
+ "beam_solar_reflectance_back": {
4895
+ "title": "Beam Solar Reflectance Back",
4896
+ "description": "The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4897
+ "default": 0.5,
4898
+ "exclusiveMaximum": 1,
4899
+ "minimum": 0,
4900
+ "type": "number",
4901
+ "format": "double"
4902
+ },
4903
+ "diffuse_solar_transmittance": {
4904
+ "title": "Diffuse Solar Transmittance",
4905
+ "description": "The slat transmittance for hemisperically diffuse solar radiation. Default value is 0.",
4906
+ "default": 0,
4907
+ "exclusiveMaximum": 1,
4908
+ "minimum": 0,
4909
+ "type": "number",
4910
+ "format": "double"
4911
+ },
4912
+ "diffuse_solar_reflectance": {
4913
+ "title": "Diffuse Solar Reflectance",
4914
+ "description": "The front-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
4915
+ "default": 0.5,
4916
+ "exclusiveMaximum": 1,
4917
+ "minimum": 0,
4918
+ "type": "number",
4919
+ "format": "double"
4920
+ },
4921
+ "diffuse_solar_reflectance_back": {
4922
+ "title": "Diffuse Solar Reflectance Back",
4923
+ "description": "The back-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
4924
+ "default": 0.5,
4925
+ "exclusiveMaximum": 1,
4926
+ "minimum": 0,
4927
+ "type": "number",
4928
+ "format": "double"
4929
+ },
4930
+ "beam_visible_transmittance": {
4931
+ "title": "Beam Visible Transmittance",
4932
+ "description": "The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.",
4933
+ "default": 0,
4934
+ "exclusiveMaximum": 1,
4935
+ "minimum": 0,
4936
+ "type": "number",
4937
+ "format": "double"
4938
+ },
4939
+ "beam_visible_reflectance": {
4940
+ "title": "Beam Visible Reflectance",
4941
+ "description": "The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4942
+ "default": 0.5,
4943
+ "exclusiveMaximum": 1,
4944
+ "minimum": 0,
4945
+ "type": "number",
4946
+ "format": "double"
4947
+ },
4948
+ "beam_visible_reflectance_back": {
4949
+ "title": "Beam Visible Reflectance Back",
4950
+ "description": "The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4951
+ "default": 0.5,
4952
+ "exclusiveMaximum": 1,
4953
+ "minimum": 0,
4954
+ "type": "number",
4955
+ "format": "double"
4956
+ },
4957
+ "diffuse_visible_transmittance": {
4958
+ "title": "Diffuse Visible Transmittance",
4959
+ "description": "The slat transmittance for hemispherically diffuse visible radiation. This value should equal \u201cSlat Beam Visible Transmittance.\u201d",
4960
+ "default": 0,
4961
+ "exclusiveMaximum": 1,
4962
+ "minimum": 0,
4963
+ "type": "number",
4964
+ "format": "double"
4965
+ },
4966
+ "diffuse_visible_reflectance": {
4967
+ "title": "Diffuse Visible Reflectance",
4968
+ "description": "The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cFront Side Slat Beam Visible Reflectance.\u201d Default value is 0.5.",
4969
+ "default": 0.5,
4970
+ "exclusiveMaximum": 1,
4971
+ "minimum": 0,
4972
+ "type": "number",
4973
+ "format": "double"
4974
+ },
4975
+ "diffuse_visible_reflectance_back": {
4976
+ "title": "Diffuse Visible Reflectance Back",
4977
+ "description": "The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cBack Side Slat Beam Visible Reflectance. Default value is 0.5.\u201d",
4978
+ "default": 0.5,
4979
+ "exclusiveMaximum": 1,
4980
+ "minimum": 0,
4981
+ "type": "number",
4982
+ "format": "double"
4983
+ },
4984
+ "infrared_transmittance": {
4985
+ "title": "Infrared Transmittance",
4986
+ "description": "The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.",
4987
+ "default": 0,
4988
+ "exclusiveMaximum": 1,
4989
+ "minimum": 0,
4990
+ "type": "number",
4991
+ "format": "double"
4992
+ },
4993
+ "emissivity": {
4994
+ "title": "Emissivity",
4995
+ "description": "Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
4996
+ "default": 0.9,
4997
+ "exclusiveMaximum": 1,
4998
+ "minimum": 0,
4999
+ "type": "number",
5000
+ "format": "double"
5001
+ },
5002
+ "emissivity_back": {
5003
+ "title": "Emissivity Back",
5004
+ "description": "Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
5005
+ "default": 0.9,
5006
+ "exclusiveMaximum": 1,
5007
+ "minimum": 0,
5008
+ "type": "number",
5009
+ "format": "double"
5010
+ },
5011
+ "distance_to_glass": {
5012
+ "title": "Distance To Glass",
5013
+ "description": "The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.",
5014
+ "default": 0.05,
5015
+ "minimum": 0.01,
5016
+ "maximum": 1,
5017
+ "type": "number",
5018
+ "format": "double"
4463
5019
  },
4464
- "display_name": {
4465
- "title": "Display Name",
4466
- "description": "Display name of the object with no character restrictions.",
4467
- "type": "string"
5020
+ "top_opening_multiplier": {
5021
+ "title": "Top Opening Multiplier",
5022
+ "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. The default value is 0.5",
5023
+ "default": 0.5,
5024
+ "minimum": 0,
5025
+ "maximum": 1,
5026
+ "type": "number",
5027
+ "format": "double"
4468
5028
  },
4469
- "type": {
4470
- "title": "Type",
4471
- "default": "AirBoundaryConstruction",
4472
- "pattern": "^AirBoundaryConstruction$",
4473
- "type": "string",
4474
- "readOnly": true
5029
+ "bottom_opening_multiplier": {
5030
+ "title": "Bottom Opening Multiplier",
5031
+ "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. The default value is 0.",
5032
+ "default": 0.5,
5033
+ "minimum": 0,
5034
+ "maximum": 1,
5035
+ "type": "number",
5036
+ "format": "double"
4475
5037
  },
4476
- "air_mixing_per_area": {
4477
- "title": "Air Mixing Per Area",
4478
- "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4479
- "default": 0.1,
5038
+ "left_opening_multiplier": {
5039
+ "title": "Left Opening Multiplier",
5040
+ "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
5041
+ "default": 0.5,
5042
+ "minimum": 0,
5043
+ "maximum": 1,
5044
+ "type": "number",
5045
+ "format": "double"
5046
+ },
5047
+ "right_opening_multiplier": {
5048
+ "title": "Right Opening Multiplier",
5049
+ "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
5050
+ "default": 0.5,
4480
5051
  "minimum": 0,
5052
+ "maximum": 1,
4481
5053
  "type": "number",
4482
5054
  "format": "double"
4483
5055
  }
4484
5056
  },
4485
5057
  "required": [
4486
- "identifier",
4487
- "air_mixing_schedule"
5058
+ "identifier"
4488
5059
  ],
4489
5060
  "additionalProperties": false
4490
5061
  },
4491
- "ConstructionSet": {
4492
- "title": "ConstructionSet",
4493
- "description": "A set of constructions for different surface types and boundary conditions.",
5062
+ "WindowConstructionShade": {
5063
+ "title": "WindowConstructionShade",
5064
+ "description": "Construction for window objects (Aperture, Door).",
4494
5065
  "type": "object",
4495
5066
  "properties": {
4496
5067
  "identifier": {
@@ -4500,157 +5071,29 @@
4500
5071
  "minLength": 1,
4501
5072
  "type": "string"
4502
5073
  },
4503
- "display_name": {
4504
- "title": "Display Name",
4505
- "description": "Display name of the object with no character restrictions.",
4506
- "type": "string"
4507
- },
4508
- "type": {
4509
- "title": "Type",
4510
- "default": "ConstructionSet",
4511
- "pattern": "^ConstructionSet$",
4512
- "type": "string",
4513
- "readOnly": true
4514
- },
4515
- "wall_set": {
4516
- "title": "Wall Set",
4517
- "description": "A WallConstructionSet object for this ConstructionSet.",
4518
- "allOf": [
4519
- {
4520
- "$ref": "#/components/schemas/WallConstructionSet"
4521
- }
4522
- ]
4523
- },
4524
- "floor_set": {
4525
- "title": "Floor Set",
4526
- "description": "A FloorConstructionSet object for this ConstructionSet.",
4527
- "allOf": [
4528
- {
4529
- "$ref": "#/components/schemas/FloorConstructionSet"
4530
- }
4531
- ]
4532
- },
4533
- "roof_ceiling_set": {
4534
- "title": "Roof Ceiling Set",
4535
- "description": "A RoofCeilingConstructionSet object for this ConstructionSet.",
4536
- "allOf": [
4537
- {
4538
- "$ref": "#/components/schemas/RoofCeilingConstructionSet"
4539
- }
4540
- ]
4541
- },
4542
- "aperture_set": {
4543
- "title": "Aperture Set",
4544
- "description": "A ApertureConstructionSet object for this ConstructionSet.",
5074
+ "window_construction": {
5075
+ "title": "Window Construction",
5076
+ "description": "A WindowConstruction object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction.",
4545
5077
  "allOf": [
4546
5078
  {
4547
- "$ref": "#/components/schemas/ApertureConstructionSet"
5079
+ "$ref": "#/components/schemas/WindowConstruction"
4548
5080
  }
4549
5081
  ]
4550
5082
  },
4551
- "door_set": {
4552
- "title": "Door Set",
4553
- "description": "A DoorConstructionSet object for this ConstructionSet.",
4554
- "allOf": [
5083
+ "shade_material": {
5084
+ "title": "Shade Material",
5085
+ "description": "Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.",
5086
+ "anyOf": [
4555
5087
  {
4556
- "$ref": "#/components/schemas/DoorConstructionSet"
4557
- }
4558
- ]
4559
- },
4560
- "shade_construction": {
4561
- "title": "Shade Construction",
4562
- "description": "A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
4563
- "allOf": [
5088
+ "$ref": "#/components/schemas/EnergyWindowMaterialShade"
5089
+ },
4564
5090
  {
4565
- "$ref": "#/components/schemas/ShadeConstruction"
4566
- }
4567
- ]
4568
- },
4569
- "air_boundary_construction": {
4570
- "title": "Air Boundary Construction",
4571
- "description": "An AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.",
4572
- "allOf": [
5091
+ "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
5092
+ },
4573
5093
  {
4574
- "$ref": "#/components/schemas/AirBoundaryConstruction"
5094
+ "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
4575
5095
  }
4576
5096
  ]
4577
- }
4578
- },
4579
- "required": [
4580
- "identifier"
4581
- ],
4582
- "additionalProperties": false
4583
- },
4584
- "OpaqueConstructionAbridged": {
4585
- "title": "OpaqueConstructionAbridged",
4586
- "description": "Construction for opaque objects (Face, Shade, Door).",
4587
- "type": "object",
4588
- "properties": {
4589
- "identifier": {
4590
- "title": "Identifier",
4591
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4592
- "maxLength": 100,
4593
- "minLength": 1,
4594
- "type": "string"
4595
- },
4596
- "layers": {
4597
- "title": "Layers",
4598
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
4599
- "minLength": 1,
4600
- "maxLength": 100,
4601
- "type": "array",
4602
- "items": {
4603
- "type": "string",
4604
- "minLength": 1,
4605
- "maxLength": 100
4606
- },
4607
- "minItems": 1,
4608
- "maxItems": 10
4609
- },
4610
- "display_name": {
4611
- "title": "Display Name",
4612
- "description": "Display name of the object with no character restrictions.",
4613
- "type": "string"
4614
- },
4615
- "type": {
4616
- "title": "Type",
4617
- "default": "OpaqueConstructionAbridged",
4618
- "pattern": "^OpaqueConstructionAbridged$",
4619
- "type": "string",
4620
- "readOnly": true
4621
- }
4622
- },
4623
- "required": [
4624
- "identifier",
4625
- "layers"
4626
- ],
4627
- "additionalProperties": false
4628
- },
4629
- "WindowConstructionAbridged": {
4630
- "title": "WindowConstructionAbridged",
4631
- "description": "Construction for window objects (Aperture, Door).",
4632
- "type": "object",
4633
- "properties": {
4634
- "identifier": {
4635
- "title": "Identifier",
4636
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4637
- "maxLength": 100,
4638
- "minLength": 1,
4639
- "type": "string"
4640
- },
4641
- "layers": {
4642
- "title": "Layers",
4643
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
4644
- "minLength": 1,
4645
- "maxLength": 100,
4646
- "type": "array",
4647
- "items": {
4648
- "type": "string",
4649
- "minLength": 1,
4650
- "maxLength": 100
4651
- },
4652
- "minItems": 1,
4653
- "maxItems": 8
4654
5097
  },
4655
5098
  "display_name": {
4656
5099
  "title": "Display Name",
@@ -4659,61 +5102,56 @@
4659
5102
  },
4660
5103
  "type": {
4661
5104
  "title": "Type",
4662
- "default": "WindowConstructionAbridged",
4663
- "pattern": "^WindowConstructionAbridged$",
5105
+ "default": "WindowConstructionShade",
5106
+ "pattern": "^WindowConstructionShade$",
4664
5107
  "type": "string",
4665
5108
  "readOnly": true
4666
- }
4667
- },
4668
- "required": [
4669
- "identifier",
4670
- "layers"
4671
- ],
4672
- "additionalProperties": false
4673
- },
4674
- "AirBoundaryConstructionAbridged": {
4675
- "title": "AirBoundaryConstructionAbridged",
4676
- "description": "Construction for Air Boundary objects.",
4677
- "type": "object",
4678
- "properties": {
4679
- "identifier": {
4680
- "title": "Identifier",
4681
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4682
- "maxLength": 100,
4683
- "minLength": 1,
4684
- "type": "string"
4685
5109
  },
4686
- "air_mixing_schedule": {
4687
- "title": "Air Mixing Schedule",
4688
- "description": "Identifier of a fractional schedule for the air mixing schedule across the construction.",
4689
- "maxLength": 100,
4690
- "minLength": 1,
5110
+ "shade_location": {
5111
+ "allOf": [
5112
+ {
5113
+ "$ref": "#/components/schemas/ShadeLocation"
5114
+ }
5115
+ ],
5116
+ "title": "Shade Location",
5117
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
5118
+ "default": "Interior",
4691
5119
  "type": "string"
4692
5120
  },
4693
- "display_name": {
4694
- "title": "Display Name",
4695
- "description": "Display name of the object with no character restrictions.",
5121
+ "control_type": {
5122
+ "allOf": [
5123
+ {
5124
+ "$ref": "#/components/schemas/ControlType"
5125
+ }
5126
+ ],
5127
+ "title": "Control Type",
5128
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5129
+ "default": "AlwaysOn",
4696
5130
  "type": "string"
4697
5131
  },
4698
- "type": {
4699
- "title": "Type",
4700
- "default": "AirBoundaryConstructionAbridged",
4701
- "pattern": "^AirBoundaryConstructionAbridged$",
4702
- "type": "string",
4703
- "readOnly": true
4704
- },
4705
- "air_mixing_per_area": {
4706
- "title": "Air Mixing Per Area",
4707
- "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4708
- "default": 0.1,
4709
- "minimum": 0,
5132
+ "setpoint": {
5133
+ "title": "Setpoint",
5134
+ "description": "A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except \"AlwaysOn.\"",
4710
5135
  "type": "number",
4711
5136
  "format": "double"
5137
+ },
5138
+ "schedule": {
5139
+ "title": "Schedule",
5140
+ "description": "An optional ScheduleRuleset or ScheduleFixedInterval to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.",
5141
+ "anyOf": [
5142
+ {
5143
+ "$ref": "#/components/schemas/ScheduleRuleset"
5144
+ },
5145
+ {
5146
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
5147
+ }
5148
+ ]
4712
5149
  }
4713
5150
  },
4714
5151
  "required": [
4715
5152
  "identifier",
4716
- "air_mixing_schedule"
5153
+ "window_construction",
5154
+ "shade_material"
4717
5155
  ],
4718
5156
  "additionalProperties": false
4719
5157
  },
@@ -4757,14 +5195,14 @@
4757
5195
  "readOnly": true
4758
5196
  },
4759
5197
  "economizer_type": {
5198
+ "allOf": [
5199
+ {
5200
+ "$ref": "#/components/schemas/EconomizerType"
5201
+ }
5202
+ ],
4760
5203
  "title": "Economizer Type",
4761
5204
  "description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.",
4762
5205
  "default": "DifferentialDryBulb",
4763
- "enum": [
4764
- "NoEconomizer",
4765
- "DifferentialDryBulb",
4766
- "DifferentialEnthalpy"
4767
- ],
4768
5206
  "type": "string"
4769
5207
  },
4770
5208
  "demand_controlled_ventilation": {
@@ -4811,7 +5249,7 @@
4811
5249
  },
4812
5250
  "heating_limit": {
4813
5251
  "title": "Heating Limit",
4814
- "description": "A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit boject to indicate no upper limit to the heating capacity.",
5252
+ "description": "A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the heating capacity.",
4815
5253
  "default": {
4816
5254
  "type": "Autosize"
4817
5255
  },
@@ -4831,7 +5269,7 @@
4831
5269
  },
4832
5270
  "cooling_limit": {
4833
5271
  "title": "Cooling Limit",
4834
- "description": "A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit boject to indicate no upper limit to the cooling capacity.",
5272
+ "description": "A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the cooling capacity.",
4835
5273
  "default": {
4836
5274
  "type": "Autosize"
4837
5275
  },
@@ -5762,7 +6200,7 @@
5762
6200
  },
5763
6201
  "interpolate": {
5764
6202
  "title": "Interpolate",
5765
- "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corrsponding to them.",
6203
+ "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
5766
6204
  "default": false,
5767
6205
  "type": "boolean"
5768
6206
  }
@@ -5820,7 +6258,7 @@
5820
6258
  "$ref": "#/components/schemas/WindowConstructionAbridged"
5821
6259
  },
5822
6260
  {
5823
- "$ref": "#/components/schemas/ShadeConstruction"
6261
+ "$ref": "#/components/schemas/WindowConstructionShadeAbridged"
5824
6262
  },
5825
6263
  {
5826
6264
  "$ref": "#/components/schemas/AirBoundaryConstructionAbridged"
@@ -5831,8 +6269,14 @@
5831
6269
  {
5832
6270
  "$ref": "#/components/schemas/WindowConstruction"
5833
6271
  },
6272
+ {
6273
+ "$ref": "#/components/schemas/WindowConstructionShade"
6274
+ },
5834
6275
  {
5835
6276
  "$ref": "#/components/schemas/AirBoundaryConstruction"
6277
+ },
6278
+ {
6279
+ "$ref": "#/components/schemas/ShadeConstruction"
5836
6280
  }
5837
6281
  ]
5838
6282
  }
@@ -5989,6 +6433,9 @@
5989
6433
  {
5990
6434
  "$ref": "#/components/schemas/Trans"
5991
6435
  },
6436
+ {
6437
+ "$ref": "#/components/schemas/Metal"
6438
+ },
5992
6439
  {
5993
6440
  "$ref": "#/components/schemas/Void"
5994
6441
  },
@@ -5999,8 +6446,7 @@
5999
6446
  },
6000
6447
  "dependencies": {
6001
6448
  "title": "Dependencies",
6002
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6003
- "default": [],
6449
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6004
6450
  "type": "array",
6005
6451
  "items": {
6006
6452
  "anyOf": [
@@ -6022,6 +6468,9 @@
6022
6468
  {
6023
6469
  "$ref": "#/components/schemas/Trans"
6024
6470
  },
6471
+ {
6472
+ "$ref": "#/components/schemas/Metal"
6473
+ },
6025
6474
  {
6026
6475
  "$ref": "#/components/schemas/Void"
6027
6476
  },
@@ -6080,6 +6529,73 @@
6080
6529
  {
6081
6530
  "$ref": "#/components/schemas/Trans"
6082
6531
  },
6532
+ {
6533
+ "$ref": "#/components/schemas/Metal"
6534
+ },
6535
+ {
6536
+ "$ref": "#/components/schemas/Void"
6537
+ },
6538
+ {
6539
+ "$ref": "#/components/schemas/Mirror"
6540
+ }
6541
+ ]
6542
+ }
6543
+ },
6544
+ "required": [
6545
+ "identifier"
6546
+ ],
6547
+ "additionalProperties": false
6548
+ },
6549
+ "Metal": {
6550
+ "title": "Metal",
6551
+ "description": "Radiance metal material.",
6552
+ "type": "object",
6553
+ "properties": {
6554
+ "identifier": {
6555
+ "title": "Identifier",
6556
+ "description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
6557
+ "type": "string"
6558
+ },
6559
+ "display_name": {
6560
+ "title": "Display Name",
6561
+ "description": "Display name of the object with no character restrictions.",
6562
+ "type": "string"
6563
+ },
6564
+ "type": {
6565
+ "title": "Type",
6566
+ "default": "metal",
6567
+ "pattern": "^metal$",
6568
+ "type": "string",
6569
+ "readOnly": true
6570
+ },
6571
+ "modifier": {
6572
+ "title": "Modifier",
6573
+ "description": "Material modifier (default: Void).",
6574
+ "default": {
6575
+ "type": "void"
6576
+ },
6577
+ "anyOf": [
6578
+ {
6579
+ "$ref": "#/components/schemas/Plastic"
6580
+ },
6581
+ {
6582
+ "$ref": "#/components/schemas/Glass"
6583
+ },
6584
+ {
6585
+ "$ref": "#/components/schemas/BSDF"
6586
+ },
6587
+ {
6588
+ "$ref": "#/components/schemas/Glow"
6589
+ },
6590
+ {
6591
+ "$ref": "#/components/schemas/Light"
6592
+ },
6593
+ {
6594
+ "$ref": "#/components/schemas/Trans"
6595
+ },
6596
+ {
6597
+ "$ref": "#/components/schemas/Metal"
6598
+ },
6083
6599
  {
6084
6600
  "$ref": "#/components/schemas/Void"
6085
6601
  },
@@ -6087,6 +6603,87 @@
6087
6603
  "$ref": "#/components/schemas/Mirror"
6088
6604
  }
6089
6605
  ]
6606
+ },
6607
+ "dependencies": {
6608
+ "title": "Dependencies",
6609
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6610
+ "type": "array",
6611
+ "items": {
6612
+ "anyOf": [
6613
+ {
6614
+ "$ref": "#/components/schemas/Plastic"
6615
+ },
6616
+ {
6617
+ "$ref": "#/components/schemas/Glass"
6618
+ },
6619
+ {
6620
+ "$ref": "#/components/schemas/BSDF"
6621
+ },
6622
+ {
6623
+ "$ref": "#/components/schemas/Glow"
6624
+ },
6625
+ {
6626
+ "$ref": "#/components/schemas/Light"
6627
+ },
6628
+ {
6629
+ "$ref": "#/components/schemas/Trans"
6630
+ },
6631
+ {
6632
+ "$ref": "#/components/schemas/Metal"
6633
+ },
6634
+ {
6635
+ "$ref": "#/components/schemas/Void"
6636
+ },
6637
+ {
6638
+ "$ref": "#/components/schemas/Mirror"
6639
+ }
6640
+ ]
6641
+ }
6642
+ },
6643
+ "r_reflectance": {
6644
+ "title": "R Reflectance",
6645
+ "description": "A value between 0 and 1 for the red channel reflectance (default: 0).",
6646
+ "default": 0.0,
6647
+ "minimum": 0,
6648
+ "maximum": 1,
6649
+ "type": "number",
6650
+ "format": "double"
6651
+ },
6652
+ "g_reflectance": {
6653
+ "title": "G Reflectance",
6654
+ "description": "A value between 0 and 1 for the green channel reflectance (default: 0).",
6655
+ "default": 0.0,
6656
+ "minimum": 0,
6657
+ "maximum": 1,
6658
+ "type": "number",
6659
+ "format": "double"
6660
+ },
6661
+ "b_reflectance": {
6662
+ "title": "B Reflectance",
6663
+ "description": "A value between 0 and 1 for the blue channel reflectance (default: 0).",
6664
+ "default": 0.0,
6665
+ "minimum": 0,
6666
+ "maximum": 1,
6667
+ "type": "number",
6668
+ "format": "double"
6669
+ },
6670
+ "specularity": {
6671
+ "title": "Specularity",
6672
+ "description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions lower than 0.9 are not realistic for metallic materials. (default: 0.9).",
6673
+ "default": 0.9,
6674
+ "minimum": 0,
6675
+ "maximum": 1,
6676
+ "type": "number",
6677
+ "format": "double"
6678
+ },
6679
+ "roughness": {
6680
+ "title": "Roughness",
6681
+ "description": "A value between 0 and 1 for the roughness, specified as the rms slope of surface facets. Roughness greater than 0.2 are not realistic (default: 0).",
6682
+ "default": 0,
6683
+ "minimum": 0,
6684
+ "maximum": 1,
6685
+ "type": "number",
6686
+ "format": "double"
6090
6687
  }
6091
6688
  },
6092
6689
  "required": [
@@ -6141,6 +6738,9 @@
6141
6738
  {
6142
6739
  "$ref": "#/components/schemas/Trans"
6143
6740
  },
6741
+ {
6742
+ "$ref": "#/components/schemas/Metal"
6743
+ },
6144
6744
  {
6145
6745
  "$ref": "#/components/schemas/Void"
6146
6746
  },
@@ -6151,8 +6751,7 @@
6151
6751
  },
6152
6752
  "dependencies": {
6153
6753
  "title": "Dependencies",
6154
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6155
- "default": [],
6754
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6156
6755
  "type": "array",
6157
6756
  "items": {
6158
6757
  "anyOf": [
@@ -6174,6 +6773,9 @@
6174
6773
  {
6175
6774
  "$ref": "#/components/schemas/Trans"
6176
6775
  },
6776
+ {
6777
+ "$ref": "#/components/schemas/Metal"
6778
+ },
6177
6779
  {
6178
6780
  "$ref": "#/components/schemas/Void"
6179
6781
  },
@@ -6212,7 +6814,7 @@
6212
6814
  },
6213
6815
  "specularity": {
6214
6816
  "title": "Specularity",
6215
- "description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic. (default: 0).",
6817
+ "description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials. (default: 0).",
6216
6818
  "default": 0,
6217
6819
  "minimum": 0,
6218
6820
  "maximum": 1,
@@ -6299,6 +6901,9 @@
6299
6901
  {
6300
6902
  "$ref": "#/components/schemas/Trans"
6301
6903
  },
6904
+ {
6905
+ "$ref": "#/components/schemas/Metal"
6906
+ },
6302
6907
  {
6303
6908
  "$ref": "#/components/schemas/Void"
6304
6909
  },
@@ -6309,8 +6914,7 @@
6309
6914
  },
6310
6915
  "dependencies": {
6311
6916
  "title": "Dependencies",
6312
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6313
- "default": [],
6917
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6314
6918
  "type": "array",
6315
6919
  "items": {
6316
6920
  "anyOf": [
@@ -6332,6 +6936,9 @@
6332
6936
  {
6333
6937
  "$ref": "#/components/schemas/Trans"
6334
6938
  },
6939
+ {
6940
+ "$ref": "#/components/schemas/Metal"
6941
+ },
6335
6942
  {
6336
6943
  "$ref": "#/components/schemas/Void"
6337
6944
  },
@@ -6421,6 +7028,9 @@
6421
7028
  {
6422
7029
  "$ref": "#/components/schemas/Trans"
6423
7030
  },
7031
+ {
7032
+ "$ref": "#/components/schemas/Metal"
7033
+ },
6424
7034
  {
6425
7035
  "$ref": "#/components/schemas/Void"
6426
7036
  },
@@ -6431,8 +7041,7 @@
6431
7041
  },
6432
7042
  "dependencies": {
6433
7043
  "title": "Dependencies",
6434
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6435
- "default": [],
7044
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6436
7045
  "type": "array",
6437
7046
  "items": {
6438
7047
  "anyOf": [
@@ -6454,6 +7063,9 @@
6454
7063
  {
6455
7064
  "$ref": "#/components/schemas/Trans"
6456
7065
  },
7066
+ {
7067
+ "$ref": "#/components/schemas/Metal"
7068
+ },
6457
7069
  {
6458
7070
  "$ref": "#/components/schemas/Void"
6459
7071
  },
@@ -6515,9 +7127,8 @@
6515
7127
  },
6516
7128
  "bsdf_data": {
6517
7129
  "title": "Bsdf Data",
6518
- "description": "BSDF xml file data as bytes.",
6519
- "type": "string",
6520
- "format": "binary"
7130
+ "description": "A string with the contents of the BSDF XML file.",
7131
+ "type": "string"
6521
7132
  },
6522
7133
  "display_name": {
6523
7134
  "title": "Display Name",
@@ -6556,6 +7167,9 @@
6556
7167
  {
6557
7168
  "$ref": "#/components/schemas/Trans"
6558
7169
  },
7170
+ {
7171
+ "$ref": "#/components/schemas/Metal"
7172
+ },
6559
7173
  {
6560
7174
  "$ref": "#/components/schemas/Void"
6561
7175
  },
@@ -6566,8 +7180,7 @@
6566
7180
  },
6567
7181
  "dependencies": {
6568
7182
  "title": "Dependencies",
6569
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6570
- "default": [],
7183
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6571
7184
  "type": "array",
6572
7185
  "items": {
6573
7186
  "anyOf": [
@@ -6589,6 +7202,9 @@
6589
7202
  {
6590
7203
  "$ref": "#/components/schemas/Trans"
6591
7204
  },
7205
+ {
7206
+ "$ref": "#/components/schemas/Metal"
7207
+ },
6592
7208
  {
6593
7209
  "$ref": "#/components/schemas/Void"
6594
7210
  },
@@ -6723,6 +7339,9 @@
6723
7339
  {
6724
7340
  "$ref": "#/components/schemas/Trans"
6725
7341
  },
7342
+ {
7343
+ "$ref": "#/components/schemas/Metal"
7344
+ },
6726
7345
  {
6727
7346
  "$ref": "#/components/schemas/Void"
6728
7347
  },
@@ -6733,8 +7352,7 @@
6733
7352
  },
6734
7353
  "dependencies": {
6735
7354
  "title": "Dependencies",
6736
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6737
- "default": [],
7355
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6738
7356
  "type": "array",
6739
7357
  "items": {
6740
7358
  "anyOf": [
@@ -6756,6 +7374,9 @@
6756
7374
  {
6757
7375
  "$ref": "#/components/schemas/Trans"
6758
7376
  },
7377
+ {
7378
+ "$ref": "#/components/schemas/Metal"
7379
+ },
6759
7380
  {
6760
7381
  "$ref": "#/components/schemas/Void"
6761
7382
  },
@@ -6853,6 +7474,9 @@
6853
7474
  {
6854
7475
  "$ref": "#/components/schemas/Trans"
6855
7476
  },
7477
+ {
7478
+ "$ref": "#/components/schemas/Metal"
7479
+ },
6856
7480
  {
6857
7481
  "$ref": "#/components/schemas/Void"
6858
7482
  },
@@ -6863,8 +7487,7 @@
6863
7487
  },
6864
7488
  "dependencies": {
6865
7489
  "title": "Dependencies",
6866
- "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: []).",
6867
- "default": [],
7490
+ "description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers (default: None).",
6868
7491
  "type": "array",
6869
7492
  "items": {
6870
7493
  "anyOf": [
@@ -6886,6 +7509,9 @@
6886
7509
  {
6887
7510
  "$ref": "#/components/schemas/Trans"
6888
7511
  },
7512
+ {
7513
+ "$ref": "#/components/schemas/Metal"
7514
+ },
6889
7515
  {
6890
7516
  "$ref": "#/components/schemas/Void"
6891
7517
  },
@@ -6924,7 +7550,7 @@
6924
7550
  },
6925
7551
  "specularity": {
6926
7552
  "title": "Specularity",
6927
- "description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic. (default: 0).",
7553
+ "description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials. (default: 0).",
6928
7554
  "default": 0,
6929
7555
  "minimum": 0,
6930
7556
  "maximum": 1,
@@ -6973,6 +7599,9 @@
6973
7599
  {
6974
7600
  "$ref": "#/components/schemas/Trans"
6975
7601
  },
7602
+ {
7603
+ "$ref": "#/components/schemas/Metal"
7604
+ },
6976
7605
  {
6977
7606
  "$ref": "#/components/schemas/Void"
6978
7607
  },
@@ -7003,6 +7632,9 @@
7003
7632
  {
7004
7633
  "$ref": "#/components/schemas/Trans"
7005
7634
  },
7635
+ {
7636
+ "$ref": "#/components/schemas/Metal"
7637
+ },
7006
7638
  {
7007
7639
  "$ref": "#/components/schemas/Void"
7008
7640
  },
@@ -7048,6 +7680,9 @@
7048
7680
  {
7049
7681
  "$ref": "#/components/schemas/Trans"
7050
7682
  },
7683
+ {
7684
+ "$ref": "#/components/schemas/Metal"
7685
+ },
7051
7686
  {
7052
7687
  "$ref": "#/components/schemas/Void"
7053
7688
  },
@@ -7078,6 +7713,9 @@
7078
7713
  {
7079
7714
  "$ref": "#/components/schemas/Trans"
7080
7715
  },
7716
+ {
7717
+ "$ref": "#/components/schemas/Metal"
7718
+ },
7081
7719
  {
7082
7720
  "$ref": "#/components/schemas/Void"
7083
7721
  },
@@ -7123,6 +7761,9 @@
7123
7761
  {
7124
7762
  "$ref": "#/components/schemas/Trans"
7125
7763
  },
7764
+ {
7765
+ "$ref": "#/components/schemas/Metal"
7766
+ },
7126
7767
  {
7127
7768
  "$ref": "#/components/schemas/Void"
7128
7769
  },
@@ -7153,6 +7794,9 @@
7153
7794
  {
7154
7795
  "$ref": "#/components/schemas/Trans"
7155
7796
  },
7797
+ {
7798
+ "$ref": "#/components/schemas/Metal"
7799
+ },
7156
7800
  {
7157
7801
  "$ref": "#/components/schemas/Void"
7158
7802
  },
@@ -7205,6 +7849,9 @@
7205
7849
  {
7206
7850
  "$ref": "#/components/schemas/Trans"
7207
7851
  },
7852
+ {
7853
+ "$ref": "#/components/schemas/Metal"
7854
+ },
7208
7855
  {
7209
7856
  "$ref": "#/components/schemas/Void"
7210
7857
  },
@@ -7235,6 +7882,9 @@
7235
7882
  {
7236
7883
  "$ref": "#/components/schemas/Trans"
7237
7884
  },
7885
+ {
7886
+ "$ref": "#/components/schemas/Metal"
7887
+ },
7238
7888
  {
7239
7889
  "$ref": "#/components/schemas/Void"
7240
7890
  },
@@ -7265,6 +7915,9 @@
7265
7915
  {
7266
7916
  "$ref": "#/components/schemas/Trans"
7267
7917
  },
7918
+ {
7919
+ "$ref": "#/components/schemas/Metal"
7920
+ },
7268
7921
  {
7269
7922
  "$ref": "#/components/schemas/Void"
7270
7923
  },
@@ -7295,6 +7948,9 @@
7295
7948
  {
7296
7949
  "$ref": "#/components/schemas/Trans"
7297
7950
  },
7951
+ {
7952
+ "$ref": "#/components/schemas/Metal"
7953
+ },
7298
7954
  {
7299
7955
  "$ref": "#/components/schemas/Void"
7300
7956
  },
@@ -7333,6 +7989,9 @@
7333
7989
  {
7334
7990
  "$ref": "#/components/schemas/Trans"
7335
7991
  },
7992
+ {
7993
+ "$ref": "#/components/schemas/Metal"
7994
+ },
7336
7995
  {
7337
7996
  "$ref": "#/components/schemas/Void"
7338
7997
  },
@@ -7363,6 +8022,9 @@
7363
8022
  {
7364
8023
  "$ref": "#/components/schemas/Trans"
7365
8024
  },
8025
+ {
8026
+ "$ref": "#/components/schemas/Metal"
8027
+ },
7366
8028
  {
7367
8029
  "$ref": "#/components/schemas/Void"
7368
8030
  },
@@ -7400,6 +8062,9 @@
7400
8062
  {
7401
8063
  "$ref": "#/components/schemas/Trans"
7402
8064
  },
8065
+ {
8066
+ "$ref": "#/components/schemas/Metal"
8067
+ },
7403
8068
  {
7404
8069
  "$ref": "#/components/schemas/Void"
7405
8070
  },
@@ -7430,6 +8095,9 @@
7430
8095
  {
7431
8096
  "$ref": "#/components/schemas/Trans"
7432
8097
  },
8098
+ {
8099
+ "$ref": "#/components/schemas/Metal"
8100
+ },
7433
8101
  {
7434
8102
  "$ref": "#/components/schemas/Void"
7435
8103
  },
@@ -7460,6 +8128,9 @@
7460
8128
  {
7461
8129
  "$ref": "#/components/schemas/Trans"
7462
8130
  },
8131
+ {
8132
+ "$ref": "#/components/schemas/Metal"
8133
+ },
7463
8134
  {
7464
8135
  "$ref": "#/components/schemas/Void"
7465
8136
  },
@@ -7498,6 +8169,9 @@
7498
8169
  {
7499
8170
  "$ref": "#/components/schemas/Trans"
7500
8171
  },
8172
+ {
8173
+ "$ref": "#/components/schemas/Metal"
8174
+ },
7501
8175
  {
7502
8176
  "$ref": "#/components/schemas/Void"
7503
8177
  },
@@ -7528,6 +8202,9 @@
7528
8202
  {
7529
8203
  "$ref": "#/components/schemas/Trans"
7530
8204
  },
8205
+ {
8206
+ "$ref": "#/components/schemas/Metal"
8207
+ },
7531
8208
  {
7532
8209
  "$ref": "#/components/schemas/Void"
7533
8210
  },
@@ -7624,7 +8301,7 @@
7624
8301
  },
7625
8302
  "air_boundary_modifier": {
7626
8303
  "title": "Air Boundary Modifier",
7627
- "description": "An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honyebee generic air wall modifier.",
8304
+ "description": "An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
7628
8305
  "anyOf": [
7629
8306
  {
7630
8307
  "$ref": "#/components/schemas/Plastic"
@@ -7644,6 +8321,9 @@
7644
8321
  {
7645
8322
  "$ref": "#/components/schemas/Trans"
7646
8323
  },
8324
+ {
8325
+ "$ref": "#/components/schemas/Metal"
8326
+ },
7647
8327
  {
7648
8328
  "$ref": "#/components/schemas/Void"
7649
8329
  },
@@ -7911,7 +8591,7 @@
7911
8591
  },
7912
8592
  "air_boundary_modifier": {
7913
8593
  "title": "Air Boundary Modifier",
7914
- "description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honyebee generic air wall modifier.",
8594
+ "description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
7915
8595
  "type": "string"
7916
8596
  }
7917
8597
  },
@@ -7934,8 +8614,7 @@
7934
8614
  },
7935
8615
  "modifiers": {
7936
8616
  "title": "Modifiers",
7937
- "description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set. (default: []).",
7938
- "default": [],
8617
+ "description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set (default: None).",
7939
8618
  "type": "array",
7940
8619
  "items": {
7941
8620
  "anyOf": [
@@ -7957,6 +8636,9 @@
7957
8636
  {
7958
8637
  "$ref": "#/components/schemas/Trans"
7959
8638
  },
8639
+ {
8640
+ "$ref": "#/components/schemas/Metal"
8641
+ },
7960
8642
  {
7961
8643
  "$ref": "#/components/schemas/Void"
7962
8644
  },
@@ -7968,8 +8650,7 @@
7968
8650
  },
7969
8651
  "modifier_sets": {
7970
8652
  "title": "Modifier Sets",
7971
- "description": "A list of all unique Room-Assigned ModifierSets in the Model (default: []).",
7972
- "default": [],
8653
+ "description": "A list of all unique Room-Assigned ModifierSets in the Model (default: None).",
7973
8654
  "type": "array",
7974
8655
  "items": {
7975
8656
  "anyOf": [
@@ -8089,29 +8770,29 @@
8089
8770
  }
8090
8771
  },
8091
8772
  "units": {
8773
+ "allOf": [
8774
+ {
8775
+ "$ref": "#/components/schemas/Units"
8776
+ }
8777
+ ],
8092
8778
  "title": "Units",
8093
8779
  "description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.",
8094
8780
  "default": "Meters",
8095
- "enum": [
8096
- "Meters",
8097
- "Millimeters",
8098
- "Feet",
8099
- "Inches",
8100
- "Centimeters"
8101
- ],
8102
8781
  "type": "string"
8103
8782
  },
8104
8783
  "tolerance": {
8105
8784
  "title": "Tolerance",
8106
- "description": "The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in no attempt to evaluate whether Room volumes are closed or check face direction. So it is recommended that this always be a positive number when such checks have not been performed on a Model. Typical tolerances for building geometry range from 0.1 to 0.0001 depending on the units of the geometry.",
8107
- "default": 0,
8785
+ "description": "The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters.",
8786
+ "default": 0.01,
8787
+ "minimum": 0,
8108
8788
  "type": "number",
8109
8789
  "format": "double"
8110
8790
  },
8111
8791
  "angle_tolerance": {
8112
8792
  "title": "Angle Tolerance",
8113
- "description": "The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in no attempt to evaluate whether the Room volumes is closed or check face direction. So it is recommended that this always be a positive number when such checks have not been performed on a given Model. Typical tolerances for building geometry are often around 1 degree.",
8114
- "default": 0,
8793
+ "description": "The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a given Model.",
8794
+ "default": 1.0,
8795
+ "minimum": 0,
8115
8796
  "type": "number",
8116
8797
  "format": "double"
8117
8798
  }
@@ -8121,6 +8802,131 @@
8121
8802
  "properties"
8122
8803
  ],
8123
8804
  "additionalProperties": false
8805
+ },
8806
+ "Roughness": {
8807
+ "title": "Roughness",
8808
+ "default": "MediumRough",
8809
+ "enum": [
8810
+ "VeryRough",
8811
+ "Rough",
8812
+ "MediumRough",
8813
+ "MediumSmooth",
8814
+ "Smooth",
8815
+ "VerySmooth"
8816
+ ],
8817
+ "type": "string"
8818
+ },
8819
+ "SlatOrientation": {
8820
+ "title": "Slat Orientation",
8821
+ "default": "Horizontal",
8822
+ "enum": [
8823
+ "Horizontal",
8824
+ "Vertical"
8825
+ ],
8826
+ "type": "string"
8827
+ },
8828
+ "GasType": {
8829
+ "title": "Gas Type",
8830
+ "default": "Air",
8831
+ "enum": [
8832
+ "Air",
8833
+ "Argon",
8834
+ "Krypton",
8835
+ "Xenon"
8836
+ ],
8837
+ "type": "string"
8838
+ },
8839
+ "FaceType": {
8840
+ "title": "Face Type",
8841
+ "enum": [
8842
+ "Wall",
8843
+ "Floor",
8844
+ "RoofCeiling",
8845
+ "AirBoundary"
8846
+ ],
8847
+ "type": "string"
8848
+ },
8849
+ "EconomizerType": {
8850
+ "title": "Economizer Type",
8851
+ "description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.",
8852
+ "default": "DifferentialDryBulb",
8853
+ "enum": [
8854
+ "NoEconomizer",
8855
+ "DifferentialDryBulb",
8856
+ "DifferentialEnthalpy"
8857
+ ],
8858
+ "type": "string"
8859
+ },
8860
+ "Units": {
8861
+ "title": "Units",
8862
+ "description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.",
8863
+ "default": "Meters",
8864
+ "enum": [
8865
+ "Meters",
8866
+ "Millimeters",
8867
+ "Feet",
8868
+ "Inches",
8869
+ "Centimeters"
8870
+ ],
8871
+ "type": "string"
8872
+ },
8873
+ "ScheduleNumericType": {
8874
+ "title": "Numeric Type",
8875
+ "default": "Continuous",
8876
+ "enum": [
8877
+ "Continuous",
8878
+ "Discrete"
8879
+ ],
8880
+ "type": "string"
8881
+ },
8882
+ "ScheduleUnitType": {
8883
+ "title": "Unit Type",
8884
+ "default": "Dimensionless",
8885
+ "enum": [
8886
+ "Dimensionless",
8887
+ "Temperature",
8888
+ "DeltaTemperature",
8889
+ "PrecipitationRate",
8890
+ "Angle",
8891
+ "ConvectionCoefficient",
8892
+ "ActivityLevel",
8893
+ "Velocity",
8894
+ "Capacity",
8895
+ "Power",
8896
+ "Availability",
8897
+ "Percent",
8898
+ "Control",
8899
+ "Mode"
8900
+ ],
8901
+ "type": "string"
8902
+ },
8903
+ "ShadeLocation": {
8904
+ "title": "Shade Location",
8905
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
8906
+ "default": "Interior",
8907
+ "enum": [
8908
+ "Interior",
8909
+ "Between",
8910
+ "Exterior"
8911
+ ],
8912
+ "type": "string"
8913
+ },
8914
+ "ControlType": {
8915
+ "title": "Control Type",
8916
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
8917
+ "default": "AlwaysOn",
8918
+ "enum": [
8919
+ "AlwaysOn",
8920
+ "OnIfHighSolarOnWindow",
8921
+ "OnIfHighHorizontalSolar",
8922
+ "OnIfHighOutdoorAirTemperature",
8923
+ "OnIfHighZoneAirTemperature",
8924
+ "OnIfHighZoneCooling",
8925
+ "OnNightIfLowOutdoorTempAndOffDay",
8926
+ "OnNightIfLowInsideTempAndOffDay",
8927
+ "OnNightIfHeatingAndOffDay"
8928
+ ],
8929
+ "type": "string"
8124
8930
  }
8125
8931
  }
8126
8932
  }