Interface MetaV16

interface MetaV16 {
    action?: "assembled" | "quick";
    activity: "retro" | "build";
    arch: "SFD" | "MURB";
    compressed: (
        | "length"
        | "type"
        | "entity"
        | "height"
        | "direction"
        | "adjacent"
        | "room"
        | "storey"
        | "perimeter"
        | "area"
        | "corners"
        | "intersections"
        | "windows"
        | "doors"
        | "header"
        | "slope"
        | "wall_entity"
        | "inside_entity"
        | "outside_entity"
        | "slab_entity"
        | "floorsAbove_entity"
        | "exterior_perimeter"
        | "above_grade_wall_area"
        | "below_grade_wall_area"
        | "depth"
        | "heated_slab"
        | "integral_footing"
        | "ponyWall"
        | "feature_entity"
        | "usage"
    )[];
    condition: "before"
    | "after";
    f280?: {
        achMode?: AchMode;
        indoor?: {
            design_cooling_temperature_C?: number;
            design_heating_temperature_C?: number;
        };
        outdoor?: {
            design_cooling_temperature_C?: number;
            design_heating_temperature_C?: number;
        };
    };
    fuelCosts?: {
        Electricity?: {
            baseCost?: number;
            cost: { limit: number; price: number }[];
        };
        Gas?: { baseCost?: number; cost: { limit: number; price: number }[] };
        "Mixed Wood"?: {
            baseCost?: number;
            cost: { limit: number; price: number }[];
        };
        Oil?: { baseCost?: number; cost: { limit: number; price: number }[] };
        Propane?: { baseCost?: number; cost: { limit: number; price: number }[] };
    };
    project: SeedProject;
    projectName?: string;
    run?: string;
    swaps: SeedSwaps;
    token: string;
    units: string;
    user?: SeedUser;
    wizard?: {
        additional?: {
            ac: boolean;
            hp?: boolean
            | "N/A";
            "N/A": boolean;
            natural_gas_fireplace: boolean;
            solar: boolean;
            wood_fireplace: boolean;
        };
        excluded_upgrades?: string[];
        excludeExistingCondition: boolean;
        fuel?: | "gas"
        | "wood"
        | "propane"
        | "oil"
        | "other"
        | "electricity"
        | "N/A";
        glassPanes?: number
        | "N/A";
        hotWaterFuel?:
            | "gas"
            | "wood"
            | "propane"
            | "oil"
            | "other"
            | "electricity"
            | "N/A"
            | "hp";
        replaced?: {
            ach: boolean;
            basement_insulation?: boolean;
            dhw: boolean;
            heating: boolean;
            "N/A": boolean;
            other: boolean;
            roof_insulation: boolean;
            vent: boolean;
            wall_insulation: boolean;
            window: boolean;
        };
    };
}

Implemented by

Properties

action? activity arch compressed condition f280? fuelCosts? project projectName? run? swaps token units user? wizard?

Properties

Optionalaction

action?: "assembled" | "quick"

activity

activity: "retro" | "build"

arch

arch: "SFD" | "MURB"

Will be deprecated Please use seed.house.space.arch instead.

compressed

compressed: (
    | "length"
    | "type"
    | "entity"
    | "height"
    | "direction"
    | "adjacent"
    | "room"
    | "storey"
    | "perimeter"
    | "area"
    | "corners"
    | "intersections"
    | "windows"
    | "doors"
    | "header"
    | "slope"
    | "wall_entity"
    | "inside_entity"
    | "outside_entity"
    | "slab_entity"
    | "floorsAbove_entity"
    | "exterior_perimeter"
    | "above_grade_wall_area"
    | "below_grade_wall_area"
    | "depth"
    | "heated_slab"
    | "integral_footing"
    | "ponyWall"
    | "feature_entity"
    | "usage"
)[]

condition

condition: "before" | "after"

Defines if the current seed represents pre or post upgrade condition. Used to filter out entities that are not the same condition.

'before' should contain only one option for equipment, while 'after' can contain many options.

Optionalf280

f280?: {
    achMode?: AchMode;
    indoor?: {
        design_cooling_temperature_C?: number;
        design_heating_temperature_C?: number;
    };
    outdoor?: {
        design_cooling_temperature_C?: number;
        design_heating_temperature_C?: number;
    };
}

Used to override the default F280 inputs. Optional

Type declaration

  • OptionalachMode?: AchMode

    For documentation purposes only. Where house.space.ach comes from, printed in the F280 report beside the air tightness. unconfirmed means nobody has said yet; a missing value prints the same way.

  • Optionalindoor?: { design_cooling_temperature_C?: number; design_heating_temperature_C?: number }

    Override the default indoor design conditions. If not set, they will be set from the default values in the F280 standard.

  • Optionaloutdoor?: { design_cooling_temperature_C?: number; design_heating_temperature_C?: number }

    Override the default outdoor design conditions. If not set, they will be taken from the climate file based on the project's lat and lng location.

OptionalfuelCosts

fuelCosts?: {
    Electricity?: {
        baseCost?: number;
        cost: { limit: number; price: number }[];
    };
    Gas?: { baseCost?: number; cost: { limit: number; price: number }[] };
    "Mixed Wood"?: {
        baseCost?: number;
        cost: { limit: number; price: number }[];
    };
    Oil?: { baseCost?: number; cost: { limit: number; price: number }[] };
    Propane?: { baseCost?: number; cost: { limit: number; price: number }[] };
}

Optional custom pricing for fuel. Price is in dollars per kWh

Any provided costs will overwrite the default pricing. Default costs will be used for any fuel type not provided.

Base cost is optional, represents a base monthly amount that is charged regardless of energy usage.

The cost array lets you specify tiered pricing where the cost changes based on the amount of energy used.

If you just want to have a single price, you can just give a single cost with the limit set to 0. For tiered pricing, you specify the limit as the amount of energy usage in kWh before the next tier of price kicks in.

project

project: SeedProject

Contains information about the project address. This will be automatically filled with the createSeedFromAddress endpoint.

OptionalprojectName

projectName?: string

Optional name of the project. This will be shown in the reports.

Optionalrun

run?: string

swaps

swaps: SeedSwaps

Specifies any swaps to be used in the seed.

See the Seed Documentation for more information.

token

token: string

units

units: string

Optionaluser

user?: SeedUser

Information about the person operating the software. Will be shown in the reports.

Optionalwizard

wizard?: {
    additional?: {
        ac: boolean;
        hp?: boolean | "N/A";
        "N/A": boolean;
        natural_gas_fireplace: boolean;
        solar: boolean;
        wood_fireplace: boolean;
    };
    excluded_upgrades?: string[];
    excludeExistingCondition: boolean;
    fuel?: "gas"
    | "wood"
    | "propane"
    | "oil"
    | "other"
    | "electricity"
    | "N/A";
    glassPanes?: number | "N/A";
    hotWaterFuel?:
        | "gas"
        | "wood"
        | "propane"
        | "oil"
        | "other"
        | "electricity"
        | "N/A"
        | "hp";
    replaced?: {
        ach: boolean;
        basement_insulation?: boolean;
        dhw: boolean;
        heating: boolean;
        "N/A": boolean;
        other: boolean;
        roof_insulation: boolean;
        vent: boolean;
        wall_insulation: boolean;
        window: boolean;
    };
}

Optional inputs for better completeSeed assumptions

Settings

Member Visibility

On This Page

Properties