Interface HouseV16

The core data structure representing a house in version 16 of the Seed schema. Contains all building components, equipment, and general characteristics.

interface HouseV16 {
    attics: Attic[];
    basements: Basement[];
    cathedrals: Cathedral[];
    crawlSpaces: CrawlSpace[];
    decks: Deck[];
    equipment: SeedEquipment;
    exposedFloors: ExposedFloor[];
    SOGs: SOG[];
    space: {
        ach: number | "";
        baseline_ach?: number | "";
        operation?: "ref" | "f280";
        rooms?: Room[];
        shape?: Position[][];
        year: number | "";
    };
    walls: Wall[];
}

Properties

attics: Attic[]

All attic spaces in the building.

Array of Attic objects that represent the ceiling/roof components being conditioned/unconditioned attic spaces.

Used to calculate:

  • Total roof area (combined with cathedrals and decks)
  • Roof heat loss based on the attic's thermal properties
  • Solar gain through roof windows/skylights in the attics (special cases for unheated attic)

For F280: Processed as thermal boundaries in energy modeling:

  • Registered as 'attic' type boundaries with opaque envelope area
  • Uses the attic's R-value for conductive heat loss calculations
  • Applies specific solar correction factors for cooling load calculations
  • Processes any windows as roof fenestration with special solar gain factors

For EnerGuide and HOT2000:

  • Mapped to elements with appropriate construction type
  • Includes properties like R-value, area, slope
  • Windows in attics are processed as skylight components
  • Distinct from other ceiling types (flat roofs, cathedral ceilings)
basements: Basement[]

All basement structures in the building.

Array of Basement objects that define below-grade spaces with their geometries, insulation properties, and thermal characteristics.

Used to calculate:

  • Basement wall heat loss both above and below soil level
  • Foundation areas, perimeters, and volumes
  • Livable basement area (areas with height ≥ 1.5m including pony walls)
  • Total heated volume contribution
  • Header and fenestration properties within basement walls
  • Highest ceiling height determination, if not specified.

For F280: Critical for foundation heat loss calculation:

  • Processed with climate data to determine ground conditions
  • Uses approximateDimensions() to derive length/width for heat flow models
  • Applies complex F280 heat flow formulas with basement configuration
  • Heat loss calculated differently for above/below grade portions
  • Includes specialized handling for heated slabs and integral footings

For EnerGuide:

  • Creates HOT2000 basement configuration codes
  • Defines insulation patterns (interior, exterior, double, under slab)
  • Includes pony wall construction when present
  • Integrates windows, doors, and headers within the basement structure
  • Sets properties for heated slabs and integral footings
cathedrals: Cathedral[]

Similar to the attic but used for vaulted ceilings. The construction of a cathedral ceiling is similar to a deck but at an angle. It also contains an air volume under its slopped roof that needs to be factored in the heat loss calculations.

crawlSpaces: CrawlSpace[]

All crawlspace structures in the building.

Array of CrawlSpace objects defining shallow foundation spaces with various ventilation types (heated, open, vented).

Used to calculate:

  • Foundation areas, perimeters, and volumes
  • Heat loss through crawlspace walls and floors
  • Slab insulation values
  • Total foundation floor area alongside basements and SOGs

For F280: Processed as special thermal boundaries:

  • Temperature differentials vary by usage type
  • Different handling for heated vs. unheated/vented crawlspaces
  • Treated with specific foundation parameters in heat flow calculations

For EnerGuide specific properties:

  • Ventilation type (heated, open, vented) affects HOT2000 configuration
  • Handled with specialized SOG configurations
  • Includes frost line and integral footing parameters
  • Incorporates headers and floorsAbove entities
decks: Deck[]

Similar to the attics but used for flat roofs and balcony spaces directly above the heated space.

equipment: SeedEquipment

All mechanical and energy systems in the building.

Contains detailed specifications for HVAC, water heating, ventilation, and renewable energy systems that affect building energy performance.

Used to calculate:

  • HVAC system efficiencies and characteristics for modeling
  • HRV efficiency and ventilation characteristics such as rates and airflow patterns
  • Heat pump presence and performance
  • Domestic hot water energy consumption based on fuel type and efficiency

For F280: Critical for heat loss/gain calculations:

  • Ventilation rates affect air leakage and mechanical ventilation heat loss
  • Duct insulation determines distribution loss/gain multipliers
  • HRV efficiency reduces ventilation heat loss through heat recovery
  • System types determine which calculations are applied

For EnerGuide: Extensively used for the rating:

  • Heating systems (furnace, boiler, baseboards, combo systems)
  • Cooling systems (heat pumps, air conditioning)
  • Ventilation (HRV, exhaust fans, supply systems)
  • DHW systems (tank type, efficiency, fuel)
  • PV systems (solar panels with area, orientation, efficiency)
  • Supplementary heating (fireplaces, wood stoves)
exposedFloors: ExposedFloor[]

All floor structures exposed to exterior/unheated conditions:

Array of ExposedFloor objects representing floors over unconditioned spaces (except for crawl spaces) or outdoor air (such as cantilevered floors or floors over garages).

It represents a boundary with heat generally flowing downward.

For F280: Included in thermal boundary calculations:

  • Registered as exposedFloor-type boundaries
  • Contributes to conductive heat loss values
  • Processed with conditioned space temperature differentials

For EnerGuide:

  • Simpler model compared to foundation types
  • Includes area, length, and R-value properties
  • Marks adjacent unheated spaces appropriately
SOGs: SOG[]

All slab-on-grade foundations in the building.

Array of SOG objects that define concrete slabs directly on grade (ground), with their insulation properties and perimeter characteristics.

Used to calculate:

  • Foundation areas and perimeters
  • Slab insulation values (below and edge)
  • Total foundation floor area alongside basements and crawlspaces
  • Frost line interactions for foundation heat loss

For F280: Treated as specialized foundation boundaries:

  • Processed with derived dimensions for heat flow models
  • Uses customized heat flow calculations from the BaseSimp model
  • Handles heated slabs and integral footings with special factors
  • Includes edge insulation effects on heat loss

For EnerGuide: Exported to HOT2000 with foundation-specific configuration:

  • Creates specialized slab configuration codes
  • Sets insulation values for slab and edge/skirt
  • Configures parameters for heated slabs
  • Sets integral footing properties
space: {
    ach: number | "";
    baseline_ach?: number | "";
    operation?: "ref" | "f280";
    rooms?: Room[];
    shape?: Position[][];
    year: number | "";
}

General characteristics of the interior space

Type declaration

  • ach: number | ""

    Air changes per hour at 50 Pa pressure difference (airtightness measurement).

    Quantifies the building envelope leakage rate. Typical values range from 1-3 ACH for airtight construction, 3-8 for average buildings, and >8 for leaky construction. Lower values indicate better airtightness.

    Used in conjunction with the building volume to determine the uncontrolled air leakage.

    For F280: Converted to equivalent leakage area (ELA) and used to determine heating and cooling air changes per hour in normal operating conditions. Predefined coefficient sets exist for values 1.5, 3.57, 4.55, and 10.35. Other values get interpolated.

    For EnerGuide: Impacts the natural air infiltration calculations in the simulation.

  • Optionalbaseline_ach?: number | ""

    Optional baseline airtightness value to calculate renovation costs

  • Optionaloperation?: "ref" | "f280"

    Operating mode for simulation.

    • 'ref': Indicates this is a reference building. Reference buildings bypass certain validation checks particularly around perimeter-to-area ratios.

    • 'f280': Indicates this house is built for F280 compliance calculations. Seeds with this mode also skip certain geometry validations that would normally apply to EnerGuide building models.

    This property affects validation rules but does not directly impact calculations in the Seed and the helpers. It primarily serves as a flag to identify the intended use of the house model.

    For EnerGuide: Leave empty for a normal operation. Specifying a value does not negatively impact EnerGuide calculations. Not directly used in HOT2000 export, but affects validation that may be performed before export.

  • Optionalrooms?: Room[]

    Array of rooms contained within the building, defining spaces and their characteristics.

    Used in the total_heated_area calculation when an explicit total heated area isn't provided. The system sums up the heated_area_m2 value of each room to determine the building's total heated area.

    For F280: Extensively used in the energy modeling system to:

    • Register rooms in the calculation system
    • Calculate occupants based on room types (bedrooms count + 1) when it is not defined
    • Associate boundaries (walls, windows) and spaces with specific rooms
    • Perform room-level heat loss and heat gain calculations

    When not provided, the system falls back to doing a block load calculation.

    For EnerGuide: Not directly used in HOT2000 exports, which use hardcoded default values and a whole-building model.

  • Optionalshape?: Position[][]

    Optional geometric representation of the building footprint as a GeoJSON Polygon coordinate array. Consists of [longitude, latitude] points defining the building's perimeter.

    Used in to determine wall orientations and for distributing windows appropriately around the building when the windows are not explicitly defined in virtual rating.

    If not provided, a default rectangular shape is created based on the building's latitude and longitude coordinates from the project information.

    For F280: Not directly used in energy modeling calculations.

    For EnerGuide: Not utilized directly in the inputs.

  • year: number | ""

    Year of construction of the building.

    The year property is documented but not directly used in calculations. Nonetheless, for low-fidelity simulations such as those done in virtual rating, the year built can help Properate fill-in the blanks.

walls: Wall[]

All exterior and unheated-facing walls in the building.

The array of Wall objects that defines the building's thermal envelope and structure. Each wall contains information about its dimensions, orientation, thermal properties, and attached components (windows/doors).

Used extensively to calculate:

  • Total above-grade heated area (wall.wall_area)
  • Various envelope areas (exterior walls, unheated adjacent walls)
  • Window and door areas from the contained fenestration objects
  • Ceiling height approximations using wall heights when not explicitly provided
  • Thermal envelope properties for heat loss calculations

For F280: Used to define thermal boundaries for energy modeling:

  • Creates room boundaries with thermal characteristics
  • Calculates conductive heat loss for each wall surface
  • Determines solar heat gain through different wall orientations
  • Provides structure for fenestration and header components
  • Contributes to air leakage distribution calculations

For EnerGuide and HOT2000:

  • Wall construction information (R-values, corners, intersections)
  • Dimensions (height, perimeter)
  • Attached components (windows, doors, headers)
  • Adjacent space relationships (heated vs. unheated)