Additional properties allowed for flexibility.
Enables custom properties for specific entity types. Used for specialized calculations or information.
OptionalcaptionOptional descriptive text.
Additional information about the entity. Used for UI display and documentation.
Due to the naming constraints, there is no guarantee that the name can be given as-is to HOT2000 export.
OptionalcarbonEmbodied carbon in kg CO2e per item unit.
Environmental impact measure for manufacturing the entity. Used in environmental impact assessments.
Components and sub-components that make up this entity. Such as the studs in a wall.
For composite entities, contains the individual elements. Used for detailed modeling and cost breakdowns.
OptionalefEnergy Factor for equipment entities. From 0 to 1.
Efficiency metric for DHW equipment. Used in energy consumption calculations.
OptionalefficiencyGeneral efficiency value (percentage).
Performance metric for mechanical systems. Used in energy consumption calculations.
OptionalfuelFuel type used by equipment entities.
Energy source for mechanical systems. Used to determine energy type, costs, and emissions.
Unique identifier of the Entity
Optionalinsulation_Insulation R-value in metric units (m²·K/W).
For Entities such as a slab, the insulation r_value can be defined separately.
OptionallabourLabour cost in dollars per item unit.
Cost of installation labour for this entity. Used in construction/renovation cost calculations.
OptionallocationGeographic information about availability.
Indicates where this entity is applicable or available. Used for region-specific filtering.
OptionalmaterialsMaterial cost in dollars per item unit.
Cost of materials for this entity. Used in construction/renovation cost calculations.
Display name of the entity.
Used for identification in the UI and the material database. This may not be human readable. Refer to "caption" and "nick" for that purpose.
Usually it is the "breed" of the entity and the "id" concatenated snake case.
OptionalrR-value. Note that it is in METRIC units (m²·K/W).
Thermal resistance for opaque assemblies or fenestration. Used in heat loss calculations and for code compliance.
OptionalshgcSolar Heat Gain Coefficient.
Fraction of solar radiation transmitted through fenestration. Used in solar gain calculations for windows and skylights.
OptionalsubstanceClassification identifier for the entity.
Categorizes the entity for filtering and organization. Used in UI presentation and entity selection logic.
Optionalsw_The origin of the Entity, this is a legacy value from StepWin and helps update older Entities but it is advisable to always define it. If you are making your own, use "generated".
Classification of the entity.
Indicates what kind of building component or equipment the entity represents. Used for filtering and appropriate property application.
Represents a constructed material, assembly, or equipment entity. Contains properties for thermal performance, cost, and composition.