-
Notifications
You must be signed in to change notification settings - Fork 18
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
Conversation
@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:
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. |
Using both |
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. |
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. 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. |
Call it |
@nmerket Here's an example HPXML with how we're using the current elements. And here is the documentation. |
schemas/HPXMLBaseElements.xsd
Outdated
<xs:element minOccurs="0" name="StationarySpas" type="StationarySpas"/> | ||
<xs:element minOccurs="0" name="PortableSpas" type="PortableSpas"/> |
There was a problem hiding this comment.
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?
merged_schema/HPXMLMerged.xsd
Outdated
<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> |
There was a problem hiding this comment.
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"?
merged_schema/HPXMLMerged.xsd
Outdated
<xs:documentation>Type of filter used, if any.</xs:documentation> | ||
</xs:annotation> | ||
</xs:element> | ||
<xs:element minOccurs="0" name="PoolPumps"> |
There was a problem hiding this comment.
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...
merged_schema/HPXMLMerged.xsd
Outdated
</xs:annotation> | ||
</xs:element> | ||
<xs:element minOccurs="0" name="ReturnPipeDiameter" type="LengthMeasurement"> | ||
<xs:element maxOccurs="unbounded" name="PoolPump"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here too.
merged_schema/HPXMLMerged.xsd
Outdated
<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> |
There was a problem hiding this comment.
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"?
|
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 toPools/Pool/Pumps/Pump
. This is for consistency in the PermanentSpas element.Spas
There is now a
Spas
element next toPools
that can contain 0 or morePermanentSpa
orPortableSpa
subelements.PermanentSpa
elements are very similar toPool
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.