v2.5.0

Version 2.5.0

BuildingSync Version 2.5.0 adds new elements for Water Conservation Measures (WCMs) and emission-related fields (Greenhouse Gas Emission). Version 2.5.0 adds examples of interactive Jupyter Notebooks to illustrate the process of creating BuildingSync XML reports from building data, where the synthetic data was generated based on DOE prototype buildings (small office and primary school).

Date Range: 10/01/21 - 09/30/23

Category	Count
Schema: Controls	0
Schema: Documentation	7
Schema: General	9
Schema: Measures	6
Schema: Reports	3
Schema: Systems	3
Schema: Validation	0
Other	13
Total	41

v2.3.1

Version 2.3.1

BuildingSync Version 2.3.1 does not introduce any breaking changes. Version 2.3.1's only change is the schemaLocation
for the gbXML Schema v6.01. The new schemaLocation points to BuildingSync's mirror of the schema. See issue #393 for more information.

v2.2.1

Version 2.2.1

BuildingSync Version 2.2.1 does not introduce any breaking changes. Version 2.2.1's only change is the schemaLocation
for the gbXML Schema v6.01. The new schemaLocation points to BuildingSync's mirror of the schema. See issue #393 for more information.

Release 3.0.0-prerelease 1

Version 3.0

Date Range: 03/11/21 - 10/01/21

Category	Count
Controls	0
Documentation	2
General	4
Measures	8
Reports	0
Systems	5
Validation	0
Other	5
Total	24

Change Type	Count
Breaking Change	18
Non-breaking Change	6

New Issues: 30 (#314, #318, #320, #321, #330, #333, #336, #337, #338, #343, #347, #356, #358, #361, #362, #370, #375, #391, #393, #397)

Closed Issues: 24

• Improved #230, Deprecate PrimaryHVACSystemType element
• Improved #233, Deprecate auc:WallID as direct child of auc:Side
• Improved #234, Deprecate auc:WindowID as direct child of auc:Side
• Improved #235, Deprecate auc:DoorID as direct child of auc:Side
• Improved #253, Deprecate OutputCapacity for HeatingSource and HeatingPlant types
• Improved #259, Deprecate auc:Delivery/auc:Capacity and auc:Delivery/auc:CapacityUnits
• Improved #264, Deprecate auc:FanSystem/auc:InstalledFlowRate
• Improved #268, Consider auc:MeasureName Refactor to minOccurs=1 maxOccurs=1
• Improved #271, Remove 'Add heat recovery' from EMCS Technology Category
• Improved #272, Redundant 'Separate SHW from heating' in Hot Water Systems and in SWH Tech Categories
• Improved #275, Remove Energy cost reduction through rate adjustments - uncategorized
• Fixed #283, Deprecate: MORE in auc:eGRIDRegionCode enumeration
• Merged #296, DuctSystem/MaximumOAFlowRate Rename
• Improved #321, Restrict BuildingSync@version to actual version
• Improved #330, Remove redundant "Add or replace cooling tower" from Other HVAC
• Merged #333, Correct capitalization in Convert to Cleaner Fuels
• Improved #336, Address issue using / with spaces
• Improved #337, Redundant Install or upgrade master venting in ChilledWaterHotWaterAndSteamDistributionSystems and OtherHVAC
• Improved #338, Remove FutureOtherECMs measure category
• Merged #343, Don't add future prerelease versions to official release schemas
• New Feature #347, Initial XSLT for translation between versions of BuildingSync
• New Feature #358, Primary, Secondary and Tertiary eGRID Subregion Codes
• New Feature #361, Update version translator to include all breaking changes
• New Feature #375, Create reverse translation from 3.0 to 2.4

Accepted Pull Requests: 24

• Merged #271, Remove 'Add heat recovery' from EMCS Technology Category
• Merged #272, Remove 'Separate SHW from heating’ from Hot Water Systems
• Merged #275, Remove Energy cost reduction through rate adjustments – uncategorized
• Merged #329, Remove redundant items
• Merged #331, Remove redundant "Add or replace cooling tower"
• Merged #334, Correct capitalization - change Convert to Cleaner Fuels to Convert to cleaner fuels
• Merged #335, Address issue using / with spaces
• Merged #341, Refactor Measurename minOccurs maxOccurs
• Fixed #342, Deprecate MORE in eGRIDRegionCode
• Merged #345, Deprecate WallID as direct child under Side
• Merged #346, Docs/versioning v3
• Merged #348, Feat/translation
• Merged #350, Refactor/update simple types
• Merged #351, Deprecate InstalledFlowRate under FanSystem
• Merged #352, Deprecate PrimaryHVACSystemType
• Merged #353, Deprecate OutputCapacity for HeatingSource and HeatingPlant types
• Merged #354, Deprecate Capacity and CapacityUnits in Delivery
• Merged #360, Feat/v2 to v3 translation updates
• Merged #364, Deprecate DoorID and WindowID as direct Child under Side
• Merged #373, Docs/selection tool
• Merged #378, Feat/v3 to v2 translation
• Merged #389, Refactor/remove old versions
• Improved #394, Deprecate eGRIDRegionCode
• Improved #396, Deprecate MaximumOAFlowRate

Release 2.4.0

Version 2.4.0

BuildingSync Version 2.4.0 does not introduce any breaking changes.

Date Range: 03/11/21 - 9/30/21

Category	Count
Controls	0
Documentation	8
General	6
Measures	0
Reports	3
Systems	2
Validation	0
Other	4
Total	23

Change Type	Count
Breaking Change	0
Non-breaking Change	23

New Issues: 30 (#305, #314, #315, #318, #320, #321, #323, #324, #325, #326, #330, #333, #336, #337, #338, #343, #347, #356, #358, #361, #362, #365, #369, #370, #375, #381, #390, #391, #393, #397)

Closed Issues: 13

• Improved #210, Change formatting of units in XSD documentation
• Merged #296, DuctSystem/MaximumOAFlowRate Rename
• New Feature #304, Develop BSync user stories:
• New Feature #305, Improve release process of schema
• Merged #315, [9/30/21] Milestone 4-3: Update Strategy Document based on FEMP and BTO feedback
• Improved #323, Deduplicate elements: ActiveDehumidification through EnergySellRate
• Improved #324, Deduplicate elements: EnergyUse through OtherControlStrategyName
• Improved #325, Deduplicate elements: OtherControlTechnology through YearOfConstruction
• Merged #326, Fix some tag names
• Merged #365, Add geometry reference sheet to releases
• Merged #369, Update URLs to selection tool
• New Feature #381, Add eGRID subregion for Puerto Rico
• Improved #390, Compare terms to most updated BEDES dictionary

Accepted Pull Requests: 23

• New Feature #298, Add AuditorYearsOfExperience
• New Feature #299, Add SpatialUnits
• New Feature #306, Add TotalCommonConditionedAboveGradeWallArea
• New Feature #307, Add TotalRoofArea
• New Feature #308, Add AuditFilingStatus
• New Feature #309, Add EarlyCompliance
• New Feature #310, Add MultiTenant
• New Feature #311, Add AverageAnnualOperatingHours
• New Feature #322, test: add test for duplicate element names
• Merged #327, build: add gh workflow for building releases
• Merged #339, docs: add versioning documentation
• Merged #344, docs: add notes for making pre-releases
• Merged #349, Refactor/remove duplicates
• Merged #366, Publish geometry reference guide on release
• Merged #368, Docs/bsync examples
• Merged #371, update links to buildingsync website
• Merged #372, fix selection tool urls
• New Feature #385, Add PRMS in eGRIDRegionCode for develop branch
• Merged #386, Update Jupyter notebook
• New Feature #387, Add eGRIDSubregionCodes
• Merged #388, renamed selection tool repo to website
• Improved #392, Update change_log.rb
• New Feature #395, Add MaximumOutsideAirFlowRate

Release 2.3.0

BuildingSync Version 2.3.0 does not introduce any breaking changes. The release also does not have any changes from Release 2.3.0-pr1.

Date Range: 09/26/20 - 12/19/20

Category	Count
Controls	0
General	2
Measures	1
Reports	3
Systems	3
Validation	0
Other	6
Total	15

Change Type	Count
Breaking Change	0
Non-breaking Change	15

New Issues: 16 (#253, #254, #259, #260, #264, #265, #268, #271, #272, #273, #274, #275, #276, #283, #284, #285)

Closed Issues: 4

• Merged #265, Add modeling of temperature time series
• Merged #273, TechnologyCategory annotations need to be updated
• Merged #274, Add 'Install electrical storage' to 'Renewable Energy Systems' TechCat
• Merged #276, Fix typo in auc:eGRIDRegionCode enumeration

Accepted Pull Requests: 15

• Merged #255, docs: add notes on git naming conventions
• Merged #256, Add LinkedSystemIDs to DuctSystem
• Merged #257, Add estimated as an "engineering calculation"
• Merged #258, docs(schema): add deprecation warning for Delivery Capacity
• Merged #261, docs(schema): add deprecation policy
• Merged #262, docs(examples): update Audit Template example files
• Merged #263, Add choice for FanInstalledFlowRate. Will deprecate InstalledFanFlowRate.
• Merged #267, Add weather station element
• Merged #269, create TimeSeriesReadingQuantity Cost
• Merged #277, Add derived models to reporting and scenarios
• Merged #278, Update annotations for data dictionary
• Merged #279, Add MROE eGridRegion
• Merged #280, Add new measure for install electrical storage
• Merged #281, Add GH Actions and Issue Templates
• Merged #282, <p> formatting in XSD

Release 2.3.0 Prerelease 1

BuildingSync Version 2.3.0-PR1 does not introduce any breaking changes.

Date Range: 09/26/20 - 12/19/20

Category	Count
Controls	0
General	2
Measures	1
Reports	3
Systems	3
Validation	0
Other	6
Total	15

Change Type	Count
Breaking Change	0
Non-breaking Change	15

New Issues: 16 (#253, #254, #259, #260, #264, #265, #268, #271, #272, #273, #274, #275, #276, #283, #284, #285)

Closed Issues: 4

• Merged #265, Add modeling of temperature time series
• Merged #273, TechnologyCategory annotations need to be updated
• Merged #274, Add 'Install electrical storage' to 'Renewable Energy Systems' TechCat
• Merged #276, Fix typo in auc:eGRIDRegionCode enumeration

Accepted Pull Requests: 15

• Merged #255, docs: add notes on git naming conventions
• Merged #256, Add LinkedSystemIDs to DuctSystem
• Merged #257, Add estimated as an "engineering calculation"
• Merged #258, docs(schema): add deprecation warning for Delivery Capacity
• Merged #261, docs(schema): add deprecation policy
• Merged #262, docs(examples): update Audit Template example files
• Merged #263, Add choice for FanInstalledFlowRate. Will deprecate InstalledFanFlowRate.
• Merged #267, Add weather station element
• Merged #269, create TimeSeriesReadingQuantity Cost
• Merged #277, Add derived models to reporting and scenarios
• Merged #278, Update annotations for data dictionary
• Merged #279, Add MROE eGridRegion
• Merged #280, Add new measure for install electrical storage
• Merged #281, Add GH Actions and Issue Templates
• Merged #282, <p> formatting in XSD

Release Version 2.2.0

BuildingSync Version 2.2.0 does not introduce any breaking changes. Version 2.2.0 adds new elements required for a
complete audit report for ASHRAE Standard 211 Level 2. This version also introduces references to the
gbXML schema. See the documentation here for more information
about this integration with gbXML.

Note that some elements are beginning to be deprecated. To ensure future conformance to the schema, these elements
should be updated to their alternative names:

Element being deprecated	New element
auc:HeatingSource/auc:OutputCapacity	auc:HeatingSource/auc:Capacity
auc:Boiler/auc:OutputCapacity	auc:Boiler/auc:Capacity
auc:DistrictHeating/auc:OutputCapacity	auc:DistrictHeating/auc:Capacity
auc:SolarThermal/auc:OutputCapacity	auc:SolarThermal/auc:Capacity
auc:PrimaryHVACSystemType	auc:PrincipalHVACSystemType

Date Range: 07/31/20 - 09/25/20

Category	Count
Controls	0
General	8
Measures	1
Reports	13
Systems	10
Validation	1
Other	4
Total	37

Change Type	Count
Breaking Change	0
Non-breaking Change	37

New Issues: 7 (#212, #218, #230, #233, #234, #235, #236)

Closed Issues: 4

• Merged #172, Promote UDF - PrincipalHVACType as part of Section.
• Merged #172, Promote UDF - PrincipalHVACType as part of Section.
• Merged #173, Promote UDF - PrincipalLightingSystemType as part of Section.
• Merged #212, Question concerning some "Other delivered" auc:FuelTypes

Accepted Pull Requests: 37

• Merged #156, gbXML External Reference
• Merged #200, Add ReadingType Cost to TimeSeries
• Merged #203, Add ResourceUseNotes to ResourceUse
• Merged #204, Add AnnualFuelCost to ResourceUse
• Merged #205, Add SimpleImpactAnalysis and CostCategory to PackageOfMeasures
• Merged #207, Add ExcludedSectionIDs to FloorArea
• Merged #208, Add LinkedPremises to Schedule
• Merged #213, Add AnnualFuelUseLinkedTimeSeriesIDs to ResourceUse
• Merged #214, Add multiple elements for energy use in AllResourceTotal
• Merged #215, Add choice between PrimaryHVACSystemType and PrincipalHVACSystemType
• Merged #216, pull rate elements out as distinct element types to reduce redundancy
• Merged #217, update tiered rate to include demand rate start and end dates
• Merged #219, feat(proposals): add proposal for versioning
• Merged #222, Add Operational enum to ScheduleCategories
• Merged #223, Add choice for multiple auc:WallIDs within auc:Side
• Merged #224, Add auc:NumberOfSides to auc:Section
• Merged #225, Add Air/WaterInfiltrationNotes to Air/WaterInfiltrationSystem
• Merged #226, Add Air/WaterInfiltrationNotes to Air/WaterInfiltrationSystem
• Merged #227, Add DeliveryCondition to Delivery
• Merged #228, Add None enum to ReheatSource
• Merged #229, Add None enum to AirSideEconomizerType
• Merged #231, Add choice for multiple auc:DoorIDs in auc:Side
• Merged #232, Add choice for multiple auc:WindowIDs in auc:Side
• Merged #237, Add Condition and Notes elements for auc:DomesticHotWaterSystem
• Merged #238, Add LightingAutomationSystem to Building and LightingSystem
• Merged #239, Add ConveyanceSystemCondition to ConveyanceSystem
• Merged #240, Add None enum to WaterSideEconomizerType
• Merged #241, Add capacity to condenser plant types
• Merged #242, Change OutputCapacity for HeatingSource and HeatingPlant types
• Merged #243, Add OverallDoorToWallRatio to Building
• Merged #244, Add EIA ID to Utility
• Merged #245, Add IntervalDuration and IntervalDurationUnits to TimeSeries
• Merged #246, Add PeakType to TimeSeries
• Merged #247, Add Load factor enum to ReadingType
• Merged #248, Add MeterID and ParentResourceUseID to ResourceUse
• Merged #250, Add NonquantifiableFactors to PackageOfMeasures

Release 2.2.0 Prerelease 1

BuildingSync Version 2.2.0-pr1 does not introduce any breaking changes. It introduces elements required for
a complete audit report for ASHRAE Standard 211 Level 1.
Note that the element auc:PrimaryHVACSystemType is in the process of being deprecated, and users should replace it with
auc:PrincipalHVACSystemType to ensure future conformance to the schema.

Date Range: 07/31/20 - 08/31/20

Category	Count
Controls	0
General	3
Measures	0
Reports	7
Systems	1
Validation	0
Other	1
Total	12

Change Type	Count
Breaking Change	0
Non-breaking Change	12

New Issues: 2 (#212, #218)

Closed Issues: 3

• Merged #172, Promote UDF - PrincipalHVACType as part of Section.
• Merged #173, Promote UDF - PrincipalLightingSystemType as part of Section.
• Merged #212, Question concerning some "Other delivered" auc:FuelTypes

Accepted Pull Requests: 12

• Merged #200, Add ReadingType Cost to TimeSeries
• Merged #203, Add ResourceUseNotes to ResourceUse
• Merged #204, Add AnnualFuelCost to ResourceUse
• Merged #205, Add SimpleImpactAnalysis and CostCategory to PackageOfMeasures
• Merged #207, Add ExcludedSectionIDs to FloorArea
• Merged #208, Add LinkedPremises to Schedule
• Merged #213, Add AnnualFuelUseLinkedTimeSeriesIDs to ResourceUse
• Merged #214, Add multiple elements for energy use in AllResourceTotal
• Merged #215, Add choice between PrimaryHVACSystemType and PrincipalHVACSystemType
• Merged #216, pull rate elements out as distinct element types to reduce redundancy
• Merged #217, update tiered rate to include demand rate start and end dates
• Merged #219, feat(proposals): add proposal for versioning

Release Version 2.1.0

BuildingSync Version 2.1.0 does not introduce any breaking changes; however, the version attribute is now required
as part of the root BuildingSync element. Version 2.1.0 includes many validation updates and additions
to support reporting auditing data. Also, the release versions now include the patch version (e.g.,
major.minor.patch).

Date Range: 12/21/19 - 07/31/20

Category	Count
Controls	0
General	7
Measures	0
Reports	0
Systems	2
Validation	2
Other	5
Total	16

Change Type	Count
Breaking Change	0
Non-breaking Change	16

New Issues: 9 (#177, #183, #184, #187, #189, #195, #197, #198, #210))

Closed Issues: 7

• Closed #159, Key / Keyref instead of ID / IDRef for limiting scope using Xpaths
• Closed #160, Create larger test suite with more comprehensive examples. Include different 'levels', then additionally create most typical HVAC systems
• Closed #177, Validate format of telephone number
• Closed #184, Add version attribute to BuildingSync element
• Closed #187, Change ID attributes for following elements to use="required"
• Closed #189, Add LinkedPremises to FanSystem and MotorSystem
• Closed #197, Review use of talking about standards within documentation

Accepted Pull Requests: 17

• Merged #178, Validate format of telephone number
• Merged #179, Validate format of postal codes.
• Merged #180, Update Audit Template examples
• Merged #185, Add EnergyCostIndex element
• Merged #186, Add BRICR example generated by Audit Template
• Merged #188, Feat/canadian provinces
• Merged #192, add LinkedPremises to FanSystem and MotorSystem
• Merged #193, feat/require IDs on all elements with an ID attribute
• Merged #194, feat/require version attribute with semantic versioning restriction
• Merged #196, update OccupantQuantityType enumerations with definitions
• Merged #199, update PrimaryHVACSystemType enumerations in line with AT tool
• Merged #201, use BEDES term for referring to ASHRAE 211
• Merged #202, feat/add OriginalOccupancyClassification element to Section
• Merged #209, Update annotations for consistency