From 6d406b334b0e6f15ade04a31c613ab738cc07147 Mon Sep 17 00:00:00 2001 From: Kelly O'Connell <89874685+kellyatradiantlabs@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:38:02 -0400 Subject: [PATCH 1/5] Revise location choices This includes (minimal) breaking changes. Some of these changes are to fix errors in v5 and some are to reflect naming conventions for v6. --- docs/source/api.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index 18f91b0..e679079 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -474,8 +474,8 @@ Property Type Units Constrai .. [#] ``systemType`` choices are "supply" and "return". .. [#] ``leakageUnits`` choices are"CFM25", "CFM50", and "percent". -.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", and "other non-freezing space". -.. [#] If ``location`` not provided, defaults to the first present space type: "basement - conditioned", "basement - unconditioned", "crawlspace - conditioned", "crawlspace - vented", "crawlspace - unvented", "attic - vented", "attic - unvented", "garage", or "living space". +.. [#] ``location`` choices are "conditioned space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", "other non-freezing space", and "manufactured home belly". +.. [#] If ``location`` not provided, defaults to the first present space type: "basement conditioned", "basement unconditioned", "crawlspace conditioned", "crawlspace vented", "crawlspace unvented", "attic vented", "attic unvented", "garage", or "conditioned space". HVAC Hydronic Distribution Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -733,12 +733,12 @@ Property Type Units .. [#] Must reference a defined ``hvacHeatingSystem.id``. .. [#] Only required when ``systemType`` is "space-heating boiler with ..." .. [#] ``fuel`` choices are "electricity", "natural gas", "fuel oil", "propane", "coal", "wood", and "wood pellets". -.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", and "other non-freezing space". +.. [#] ``location`` choices are "conditioned space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, or “other non-freezing space”. .. [#] If ``location`` not provided, defaults to the first present space type: - IECC zones 1-3, excluding 3A: "garage", "living space" + IECC zones 1-3, excluding 3A: "garage", "conditioned space" - IECC zones 3A, 4-8, unknown: "basement - conditioned", "basement - unconditioned", "living space" + IECC zones 3A, 4-8, unknown: "basement conditioned", "basement unconditioned", "conditioned space" .. _weather: From 9170de4c9af13108b7c47e6abdd9a9b6717dfd76 Mon Sep 17 00:00:00 2001 From: Kelly O'Connell <89874685+kellyatradiantlabs@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:39:49 -0400 Subject: [PATCH 2/5] Revise location options includes breaking changes --- docs/source/schemas/request/HVAC.json5 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/schemas/request/HVAC.json5 b/docs/source/schemas/request/HVAC.json5 index 8245acf..23c5b82 100644 --- a/docs/source/schemas/request/HVAC.json5 +++ b/docs/source/schemas/request/HVAC.json5 @@ -73,7 +73,7 @@ "insulationRValue": 0.0, "leakageValue": 0.2, "leakageUnits": "percent", // ("CFM25" | "CFM50" | "percent") - "location": "attic vented" // (“living space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space”) + "location": "attic vented" // (“conditioned space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space” | "manufactured home belly") }, { "id": "HVACDistributionFurnaceAndCentral1Return", @@ -81,7 +81,7 @@ "insulationRValue": 0.0, "leakageValue": 0.2, "leakageUnits": "percent", // ("CFM25" | "CFM50" | "percent") - "location": "attic vented" // (“living space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space”) + "location": "attic vented" // (“conditioned space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space” | "manufactured home belly") }, ] } From 333ed925d4b6bc1cedfd9fb83ad5cbcf498e47da Mon Sep 17 00:00:00 2001 From: Kelly O'Connell <89874685+kellyatradiantlabs@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:53:05 -0400 Subject: [PATCH 3/5] Update location options Adjusting location options to only reflect v5 requirements --- docs/source/api.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index e679079..e17e0c9 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -474,8 +474,8 @@ Property Type Units Constrai .. [#] ``systemType`` choices are "supply" and "return". .. [#] ``leakageUnits`` choices are"CFM25", "CFM50", and "percent". -.. [#] ``location`` choices are "conditioned space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", "other non-freezing space", and "manufactured home belly". -.. [#] If ``location`` not provided, defaults to the first present space type: "basement conditioned", "basement unconditioned", "crawlspace conditioned", "crawlspace vented", "crawlspace unvented", "attic vented", "attic unvented", "garage", or "conditioned space". +.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", and "other non-freezing space". +.. [#] If ``location`` not provided, defaults to the first present space type: "basement conditioned", "basement unconditioned", "crawlspace conditioned", "crawlspace vented", "crawlspace unvented", "attic vented", "attic unvented", "garage", or "living space". HVAC Hydronic Distribution Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -733,12 +733,12 @@ Property Type Units .. [#] Must reference a defined ``hvacHeatingSystem.id``. .. [#] Only required when ``systemType`` is "space-heating boiler with ..." .. [#] ``fuel`` choices are "electricity", "natural gas", "fuel oil", "propane", "coal", "wood", and "wood pellets". -.. [#] ``location`` choices are "conditioned space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, or “other non-freezing space”. +.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, or “other non-freezing space”. .. [#] If ``location`` not provided, defaults to the first present space type: - IECC zones 1-3, excluding 3A: "garage", "conditioned space" + IECC zones 1-3, excluding 3A: "garage", "living space" - IECC zones 3A, 4-8, unknown: "basement conditioned", "basement unconditioned", "conditioned space" + IECC zones 3A, 4-8, unknown: "basement conditioned", "basement unconditioned", "living space" .. _weather: From a5a86b7b4d523e720e2cdd44921ffd21bf787fd3 Mon Sep 17 00:00:00 2001 From: Kelly O'Connell <89874685+kellyatradiantlabs@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:53:59 -0400 Subject: [PATCH 4/5] Fix typo --- docs/source/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index e17e0c9..7d2e51b 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -733,7 +733,7 @@ Property Type Units .. [#] Must reference a defined ``hvacHeatingSystem.id``. .. [#] Only required when ``systemType`` is "space-heating boiler with ..." .. [#] ``fuel`` choices are "electricity", "natural gas", "fuel oil", "propane", "coal", "wood", and "wood pellets". -.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, or “other non-freezing space”. +.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, and “other non-freezing space”. .. [#] If ``location`` not provided, defaults to the first present space type: IECC zones 1-3, excluding 3A: "garage", "living space" From e59dcf97888098a88d312739f3c7644ef5fd790c Mon Sep 17 00:00:00 2001 From: Kelly O'Connell <89874685+kellyatradiantlabs@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:55:11 -0400 Subject: [PATCH 5/5] Reverting location changes Moving this to v6 branch instead --- docs/source/schemas/request/HVAC.json5 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/schemas/request/HVAC.json5 b/docs/source/schemas/request/HVAC.json5 index 23c5b82..8245acf 100644 --- a/docs/source/schemas/request/HVAC.json5 +++ b/docs/source/schemas/request/HVAC.json5 @@ -73,7 +73,7 @@ "insulationRValue": 0.0, "leakageValue": 0.2, "leakageUnits": "percent", // ("CFM25" | "CFM50" | "percent") - "location": "attic vented" // (“conditioned space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space” | "manufactured home belly") + "location": "attic vented" // (“living space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space”) }, { "id": "HVACDistributionFurnaceAndCentral1Return", @@ -81,7 +81,7 @@ "insulationRValue": 0.0, "leakageValue": 0.2, "leakageUnits": "percent", // ("CFM25" | "CFM50" | "percent") - "location": "attic vented" // (“conditioned space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space” | "manufactured home belly") + "location": "attic vented" // (“living space” | “basement conditioned” | “basement unconditioned” | “crawlspace unvented” | “crawlspace vented” | “attic unvented” | “attic vented” | “garage” | “outside” | “exterior wall” | “under slab” | “roof deck” | “other heated space” | “other non-freezing space”) }, ] }