Skip to content

Daylighting

9 object types from idfpy.models.daylighting · EnergyPlus 26.2

Object Summary
Daylighting:Controls Dimming of overhead electric lighting is determined from each reference point.
Daylighting:DELight:ComplexFenestration Used for DElight Complex Fenestration of all types
Daylighting:ReferencePoint Used by Daylighting:Controls to identify the reference point coordinates for each sensor.
DaylightingDevice:LightWell Applies only to exterior windows in daylighting-controlled zones or in zones that share an interior window …
DaylightingDevice:Shelf Defines a daylighting which can have an inside shelf, an outside shelf, or both.
DaylightingDevice:Tubular Defines a tubular daylighting device (TDD) consisting of three components: a dome, a pipe, and a diffuser.
Output:DaylightFactors Reports hourly daylight factors for each exterior window for four sky types (clear, turbid clear, …
Output:IlluminanceMap reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference …
OutputControl:IlluminanceMap:Style default style for the Daylighting Illuminance Map is comma -- this works well for importing into spreadsheet …

Daylighting:Controls

from idfpy.models import DaylightingControls extensible

Dimming of overhead electric lighting is determined from each reference point. Glare from daylighting is also calculated.

Field Type Default Details
name
Name required
string
zone_or_space_name
Zone or Space Name required
reference Names a Space, Zone
daylighting_method
Daylighting Method
choice SplitFlux One of DElight, SplitFlux
availability_schedule_name
Availability Schedule Name
reference Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
lighting_control_type
Lighting Control Type
choice Continuous One of Continuous, ContinuousOff, Stepped
minimum_input_power_fraction_for_continuous_or_continuousoff_dimming_control
Minimum Input Power Fraction for Continuous or ContinuousOff Dimming Control
number 0.3 Range: ≥ 0, ≤ 0.6
minimum_light_output_fraction_for_continuous_or_continuousoff_dimming_control
Minimum Light Output Fraction for Continuous or ContinuousOff Dimming Control
number 0.2 Range: ≥ 0, ≤ 0.6
number_of_stepped_control_steps
Number of Stepped Control Steps
integer 1 The number of steps, excluding off, in a stepped lighting control system. If Lighting Control Type is Stepped, this field must be greater than zero. The steps are assumed to be equally spaced.
Range: ≥ 1
probability_lighting_will_be_reset_when_needed_in_manual_stepped_control
Probability Lighting will be Reset When Needed in Manual Stepped Control
number 1.0 Range: ≥ 0, ≤ 1
glare_calculation_daylighting_reference_point_name
Glare Calculation Daylighting Reference Point Name
reference Names a Daylighting:ReferencePoint
glare_calculation_azimuth_angle_of_view_direction_clockwise_from_zone_y_axis
Glare Calculation Azimuth Angle of View Direction Clockwise from Zone y-Axis
number
deg
0.0 Range: ≥ 0, ≤ 360
maximum_allowable_discomfort_glare_index
Maximum Allowable Discomfort Glare Index
number 22.0 The default is for general office work
Range: ≥ 1
delight_gridding_resolution
DElight Gridding Resolution
number
m2
Maximum surface area for nodes in gridding all surfaces in the DElight zone. All reflective and transmitting surfaces will be subdivided into approximately square nodes that do not exceed this maximum. Higher resolution subdivisions require greater calculation times, but generally produce more accurate results.
Range: > 0
control_data list Each item: daylighting_reference_point_name, fraction_of_lights_controlled_by_reference_point, illuminance_setpoint_at_reference_point (lux)
Referenced by 1 object types

WindowShadingControl

Daylighting:DELight:ComplexFenestration

from idfpy.models import DaylightingDELightComplexFenestration

Used for DElight Complex Fenestration of all types

Field Type Default Details
name
Name required
string Only used for user reference
complex_fenestration_type
Complex Fenestration Type required
string Used to select the appropriate Complex Fenestration BTDF data
building_surface_name
Building Surface Name required
reference This is a reference to a valid surface object (such as BuildingSurface:Detailed) hosting this complex fenestration, analogous to the base surface Name field for subsurfaces such as Windows.
Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
window_name
Window Name required
reference This is a reference to a valid FenestrationSurface:Detailed window object used to account for the geometry, and the solar and thermal gains/losses, of the Complex Fenestration
Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
fenestration_rotation
Fenestration Rotation
number
deg
0.0 In-plane counter-clockwise rotation angle of the Complex Fenestration optical reference direction and the base edge of the Complex Fenestration. The Rotation will typically be zero when the host and CFS surfaces are rectangular and height and width edges are aligned.

Daylighting:ReferencePoint

from idfpy.models import DaylightingReferencePoint

Used by Daylighting:Controls to identify the reference point coordinates for each sensor. Reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field.

Field Type Default Details
name
Name required
string
zone_or_space_name
Zone or Space Name required
reference Names a Space, Zone
x_coordinate_of_reference_point
X-Coordinate of Reference Point required
number
m
y_coordinate_of_reference_point
Y-Coordinate of Reference Point required
number
m
z_coordinate_of_reference_point
Z-Coordinate of Reference Point
number
m
0.8
Referenced by 1 object types

Daylighting:Controls

DaylightingDevice:LightWell

from idfpy.models import DaylightingDeviceLightWell

Applies only to exterior windows in daylighting-controlled zones or in zones that share an interior window with a daylighting-controlled zone. Generally used with skylights.

Field Type Default Details
exterior_window_name
Exterior Window Name required
reference Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
height_of_well
Height of Well required
number
m
Distance from Bottom of Window to Bottom of Well
Range: ≥ 0
perimeter_of_bottom_of_well
Perimeter of Bottom of Well required
number
m
Range: > 0
area_of_bottom_of_well
Area of Bottom of Well required
number
m2
Range: > 0
visible_reflectance_of_well_walls
Visible Reflectance of Well Walls required
number
dimensionless
Range: ≥ 0, ≤ 1

DaylightingDevice:Shelf

from idfpy.models import DaylightingDeviceShelf

Defines a daylighting which can have an inside shelf, an outside shelf, or both. The inside shelf is defined as a building surface and the outside shelf is defined as a shading surface.

Field Type Default Details
name
Name required
string
window_name
Window Name required
reference Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
inside_shelf_name
Inside Shelf Name
reference This must refer to a BuildingSurface:Detailed or equivalent object This surface must be its own Surface for other side boundary conditions.
Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
outside_shelf_name
Outside Shelf Name
reference This must refer to a Shading:Zone:Detailed object
Names a Shading:Fin, Shading:Fin:Projection, Shading:Overhang, Shading:Overhang:Projection, Shading:Zone:Detailed
outside_shelf_construction_name
Outside Shelf Construction Name
reference Required if outside shelf is specified
Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
view_factor_to_outside_shelf
View Factor to Outside Shelf
number Range: ≥ 0, ≤ 1

DaylightingDevice:Tubular

from idfpy.models import DaylightingDeviceTubular extensible

Defines a tubular daylighting device (TDD) consisting of three components: a dome, a pipe, and a diffuser. The dome and diffuser are defined separately using the FenestrationSurface:Detailed object.

Field Type Default Details
name
Name required
string
dome_name
Dome Name required
reference This must refer to a subsurface object of type TubularDaylightDome
Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
diffuser_name
Diffuser Name required
reference This must refer to a subsurface object of type TubularDaylightDiffuser Delivery zone is specified in the diffuser object
Names a Door, Door:Interzone, FenestrationSurface:Detailed, GlazedDoor, GlazedDoor:Interzone, Window, Window:Interzone
construction_name
Construction Name required
reference Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
diameter
Diameter required
number
m
Range: > 0
total_length
Total Length required
number
m
The exterior exposed length is the difference between total and sum of zone lengths
Range: > 0
effective_thermal_resistance
Effective Thermal Resistance
number
m2-K/W
0.28 R value between TubularDaylightDome and TubularDaylightDiffuser
Range: > 0
transition_lengths list Each item: transition_zone_name, transition_zone_length (m)

Output:DaylightFactors

from idfpy.models import OutputDaylightFactors

Reports hourly daylight factors for each exterior window for four sky types (clear, turbid clear, intermediate, and overcast).

Field Type Default Details
reporting_days
Reporting Days required
choice One of AllShadowCalculationDays, SizingDays

Output:IlluminanceMap

from idfpy.models import OutputIlluminanceMap

reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field

Field Type Default Details
name
Name required
string
zone_or_space_name
Zone or Space Name required
reference Names a Space, Zone
z_height
Z height
number
m
0.0
x_minimum_coordinate
X Minimum Coordinate
number
m
0.0
x_maximum_coordinate
X Maximum Coordinate
number
m
1.0
number_of_x_grid_points
Number of X Grid Points
integer 2 Maximum number of total grid points must be <= 2500 (X*Y)
Range: ≥ 1
y_minimum_coordinate
Y Minimum Coordinate
number
m
0.0
y_maximum_coordinate
Y Maximum Coordinate
number
m
1.0
number_of_y_grid_points
Number of Y Grid Points
integer 2 Maximum number of total grid points must be <= 2500 (X*Y)
Range: ≥ 1

OutputControl:IlluminanceMap:Style

from idfpy.models import OutputControlIlluminanceMapStyle unique

default style for the Daylighting Illuminance Map is comma -- this works well for importing into spreadsheet programs such as Excel™ but not so well for word processing programs -- there tab may be a better choice. fixed puts spaces between the "columns"

Field Type Default Details
column_separator
Column Separator
choice Comma One of Comma, Fixed, Tab