Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PermanentSpa and PortableSpa #229

Merged
merged 22 commits into from
Sep 26, 2023
Merged

Add PermanentSpa and PortableSpa #229

merged 22 commits into from
Sep 26, 2023

Conversation

joseph-robertson
Copy link
Contributor

@joseph-robertson joseph-robertson commented May 29, 2020

There are now 3 elements:

Pools

This is mostly unchanged except that it moves all the subelements to a type to be reused.

Breaking Change Pools/Pool/PoolPumps/PoolPump have been renamed to Pools/Pool/Pumps/Pump. This is for consistency in the PermanentSpas element.

HPXMLBaseElements_Pools

Spas

There is now a Spas element next to Pools that can contain 0 or more PermanentSpa or PortableSpa subelements.

  • PermanentSpa elements are very similar to Pool and extend the same complex data type. Additional spa-specific elements can be added with this type extension organization.
  • PortableElectricSpa has the elements in the Energy Guide label below. The data field annotations reference the standard.

HPXMLBaseElements_Spas

@joseph-robertson joseph-robertson marked this pull request as ready for review June 4, 2020 21:00
@shorowit shorowit mentioned this pull request Jul 8, 2020
@nmerket
Copy link
Contributor

nmerket commented May 13, 2021

@joseph-robertson @shorowit I was just talking to Jeff Farlow from the working group about this PR. He is an expert in pool and spa energy use. I think we'll want to change a few things here to better describe these. There's a distinction between the properties of a Spa and a Hot Tub:

  • Spa:
    • Site built and usually in-ground like a pool.
    • Has the same general properties as a pool that's smaller has a higher heating setpoint.
    • Pool (and spa) pumps are now federally regulated. We may want look into capturing that information.
  • Hot Tub:
    • Packaged unit that's delivered, plugged in, and filled with water.
    • It's hard to know much about the pump of a hot tub because it's all packaged and buried in the unit.
    • Pumps are generally excepted from performance requirements in programs because they're difficult to replace.
    • Most common energy efficiency measures are related to insulating the walls and cover.

He's going to chat with someone on the hot tub side of things next week and draft out a list of what properties should be used to describe a spa vs a hot tub and send it over to me. At that point I think we can iterate on what an updated schema design should be.

@lirainer
Copy link

Using both Spa and HotTub may confuse things as everyone has their own definition and it's not very extensible. I suggest using just Spa and then differentiating with Type than can be in-ground, above-ground, or portable. You can think about portable spas as an appliance since they are cord and plug. They can have a standby power rating in watts and a capacity in gallons and/or number of people.

@shorowit shorowit modified the milestones: v3.1, v4.0 Mar 29, 2022
@nmerket
Copy link
Contributor

nmerket commented Jul 11, 2023

We'd like to have one element. The main difference is portable vs. in-ground, which could be specified as a type as @lirainer said. The portable can be treated more like an appliance, whereas the in ground spa is more like a pool.

I will reach out to the person on the working group who is associated with the pool and spa industry and get some more information about the high-level organization and whether the subelements are reasonable.

@nmerket
Copy link
Contributor

nmerket commented Jul 12, 2023

@nmerket
Copy link
Contributor

nmerket commented Aug 8, 2023

Have separate elements for portable electric spa vs permanent spa. Permanent spa is more like a pool in its elements. Portable electric spas will be more like and appliance and have properties from their energy guide label.

image

Pool/spa combos are common and share a pump and heater. Have a pool with an attached spa, a stand alone in ground spa, and finally a portable electric spa.

@nmerket
Copy link
Contributor

nmerket commented Aug 8, 2023

@nmerket
Copy link
Contributor

nmerket commented Sep 8, 2023

Call it PortableSpa and InGroundSpa. Add a fuel type.

@shorowit
Copy link
Contributor

shorowit commented Sep 8, 2023

@nmerket Here's an example HPXML with how we're using the current elements. And here is the documentation.

@nmerket nmerket changed the title Add HotTubs/HotTub (like Pools/Pool) Add StationarySpa and PortableSpa Sep 15, 2023
@nmerket nmerket requested a review from shorowit September 18, 2023 17:50
Comment on lines 4471 to 4472
<xs:element minOccurs="0" name="StationarySpas" type="StationarySpas"/>
<xs:element minOccurs="0" name="PortableSpas" type="PortableSpas"/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of separate StationarySpas/StationarySpa and PortableSpas/PortableSpa, could we have StationarySpa and PortableSpa inside a single Spas parent?

<xs:group ref="SystemInfo"/>
<xs:element minOccurs="0" name="Type" type="PoolType">
<xs:annotation>
<xs:documentation>Indicates if the pool is above or below ground.</xs:documentation>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update all the references inside PoolSpaType from "pool" to "pool or stationary spa"?

<xs:documentation>Type of filter used, if any.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="PoolPumps">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be renamed to just Pumps since it shows up for StationarySpa too? Obviously a breaking change...

</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="ReturnPipeDiameter" type="LengthMeasurement">
<xs:element maxOccurs="unbounded" name="PoolPump">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too.

<xs:element minOccurs="0" name="Fuel" type="FuelType"/>
<xs:element minOccurs="0" name="Volume" type="Volume">
<xs:annotation>
<xs:documentation>[gal] Rated volume of hot tub.</xs:documentation>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the elements under PortableSpa refer to "hot tub", should they be changed to "portable spa or hot tub"?

@shorowit shorowit changed the title Add StationarySpa and PortableSpa Add PermanentSpa and PortableSpa Sep 19, 2023
@nmerket
Copy link
Contributor

nmerket commented Sep 19, 2023

  • Add AttachedToPool element to PermanentSpa
  • Change PortableSpa to PortableElectricSpa and remove Fuel subelement.
  • Fix typo under MaximumStandbyPowerAllowed "24" -> "14"

@nmerket nmerket added the merge label Sep 21, 2023
@nmerket nmerket merged commit d52a8d2 into master Sep 26, 2023
@nmerket nmerket deleted the hottubs branch September 26, 2023 14:48
@nmerket
Copy link
Contributor

nmerket commented Sep 26, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants