libhaystack 3.1.3

ver:"3.0"
def,is,of,docTaxonomy,doc,lib,tagOn,notInherited,accumulate,reciprocalOf,computedFromReciprocal,docAssociations,dis,mime,fileExt,wikipedia,openEnum,enum,version,baseUri,noSideEffects,transitive,quantityOf,prefUnit,depends,children,childrenFlatten,mandatory,containedBy,inputs,minVal,transient,maxVal
^association,[^list],^symbol,M,"Associations model ontological relationships between definitions.\nSee [Associations]`docHaystack::Associations` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^reciprocalOf,[^symbol],,,"Specifies the inverse of an association or relationships.\nSee [Associations]`docHaystack::Associations#reciprocalOf` and\n[Relationships]`docHaystack::Relationships#reciprocalOf` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^is,[^association],^symbol,,"Defines one or more supertypes of a subtyping relationship.\nSee [Subtyping]`docHaystack::Subtyping` chapter.",^lib:ph,[^def],,,,,,,,,,,,,,,,,,,,,,,,,,
^tagOn,[^association],^symbol,,"This tag is used on the given entity",^lib:ph,[^def],M,M,^tags,,,,,,,,,,,,,,,,,,,,,,,
^tags,[^association],^symbol,,"Tags used with this entity",^lib:ph,,,,^tagOn,M,M,,,,,,,,,,,,,,,,,,,,,
^entity,[^marker],,,"Top-level dicts with a unique identifier.\nSee `docHaystack::Ontology#entities` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^id,[^ref],,,"Defines the unique identifier of an entity in system using a `ref` value\ntype. The scope of an entity is undefined, but must be unique with a\ngiven system or project. This identifier may be used by other entities\nfor cross-referencing.  See `docHaystack::Ontology#entities` chapter.",^lib:ph,[^entity],,,,,,,,,,,,,,,,,,,,,,,,,,
^dis,[^str],,,"Display name for an entity.\nSee `docHaystack::Ontology#entities` chapter.",^lib:ph,[^entity],,,,,,,,,,,,,,,,,,,,,,,,,,
^filetype,[^feature],,,"File format type definition",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^mime,[^str],,,"Mime type formatted as type/subtype",^lib:ph,[^filetype],,,,,,,,,,,,,,,,,,,,,,,,,,
^fileExt,[^str],,,"Filename extension such as \"csv\"",^lib:ph,[^filetype],,,,,,,,,,,,,,,,,,,,,,,,,,
^filetype:csv,[^filetype],,,"Comma Separated Values - see `docHaystack::Csv`",^lib:ph,,,,,,,"CSV","text/csv","csv",`https://wikipedia.org/wiki/Comma-separated_values`,,,,,,,,,,,,,,,,,
^filetype:json,[^filetype],,,"Haystack JavaScript Object Notation format - see `docHaystack::Json`",^lib:ph,,,,,,,"JSON","application/json","json",`https://wikipedia.org/wiki/JSON`,,,,,,,,,,,,,,,,,
^filetype:jsonld,[^filetype],,,"JavaScript Object Notation for Linked Data - see `docHaystack::Rdf`",^lib:ph,,,,,,,"JSON-LD","application/ld+json","jsonld",`https://wikipedia.org/wiki/JSON-LD`,,,,,,,,,,,,,,,,,
^filetype:trio,[^filetype],,,"Haystack Tag Record Input Output - see `docHaystack::Trio`",^lib:ph,,,,,,,"Trio","text/trio","trio",,,,,,,,,,,,,,,,,,
^filetype:turtle,[^filetype],,,"RDF Turtle - see `docHaystack::Rdf`",^lib:ph,,,,,,,"Turtle","text/turtle","ttl",`https://wikipedia.org/wiki/Turtle_(syntax)`,,,,,,,,,,,,,,,,,
^filetype:zinc,[^filetype],,,"Haystack typed CSV format - see `docHaystack::Zinc`",^lib:ph,,,,,,,"Zinc","text/zinc","zinc",,,,,,,,,,,,,,,,,,
^geoPlace,[^marker],,,"Geographic place",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^geoAddr,[^str],,,"Free form street address.  Best practice is to follow local\nnorms for a postal address.  Typically this string includes\nthe `geoStreet`, `geoCity`, `geoState` (in US), and `geoPostalCode`:\nExamples:\n\"1600 Pennsylvania Avenue NW, Washington, DC 20500\"\n\"10 Downing St, Westminster, London SW1A 2AA, United Kingdom\"\n\"Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France\"",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoCoord,[^coord],,,"Geographic coordinate as 'C(latitude,longitude)'",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoElevation,[^number],,,"Elevation above sea-level of the location",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoStreet,[^str],,,"Geographic street address and name",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoCity,[^str],,,"Geographic city or locality name",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoCounty,[^str],,,"Geographic subdivision of US state",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoPostalCode,[^str],,,"Geographic postal code; for US this is a five digit zip code",^lib:ph,[^geoPlace],,,,,,,,,,,,,,,,,,,,,,,,,,
^geoState,[^str],,,"State or province name; for US this is two letter state code. May be\nused in other countries to model administrative area between the geoCity\nand geoCountry level.",^lib:ph,[^geoPlace],,,,,,,,,,M,"- AL: Alabama\n- AK: Alaska\n- AS: American Samoa\n- AZ: Arizona\n- AR: Arkansas\n- CA: California\n- CO: Colorado\n- CT: Connecticut\n- DE: Delaware\n- DC: District of Columbia\n- FM: Federated States of Micronesia\n- FL: Florida\n- GA: Georgia\n- GU: Guam\n- HI: Hawaii\n- ID: Idaho\n- IL: Illinois\n- IN: Indiana\n- IA: Iowa\n- KS: Kansas\n- KY: Kentucky\n- LA: Louisiana\n- ME: Maine\n- MH: Marshall Islands\n- MD: Maryland\n- MA: Massachusetts\n- MI: Michigan\n- MN: Minnesota\n- MS: Mississippi\n- MO: Missouri\n- MT: Montana\n- NE: Nebraska\n- NV: Nevada\n- NH: New Hampshire\n- NJ: New Jersey\n- NM: New Mexico\n- NY: New York\n- NC: North Carolina\n- ND: North Dakota\n- MP: Northern Mariana Islands\n- OH: Ohio\n- OK: Oklahoma\n- OR: Oregon\n- PW: Palau\n- PA: Pennsylvania\n- PR: Puerto Rico\n- RI: Rhode Island\n- SC: South Carolina\n- SD: South Dakota\n- TN: Tennessee\n- TX: Texas\n- UT: Utah\n- VA: Virginia\n- VI: Virgin Islands\n- VT: Vermont\n- WA: Washington\n- WV: West Virginia\n- WI: Wisconsin\n- WY: Wyoming",,,,,,,,,,,,,,,
^geoCountry,[^str],,,"Geographic country as [ISO 3166-1]`http://en.wikipedia.org/wiki/ISO_3166-1`\ntwo letter code",^lib:ph,[^geoPlace],,,,,,,,,,,"- AF: Afghanistan\n- AX: Aland Islands\n- AL: Albania\n- DZ: Algeria\n- AS: American Samoa\n- AD: Andorra\n- AO: Angola\n- AI: Anguilla\n- AQ: Antarctica\n- AG: Antigua and Barbuda\n- AR: Argentina\n- AM: Armenia\n- AW: Aruba\n- AU: Australia\n- AT: Austria\n- AZ: Azerbaijan\n- BS: Bahamas\n- BH: Bahrain\n- BD: Bangladesh\n- BB: Barbados\n- BY: Belarus\n- BE: Belgium\n- BZ: Belize\n- BJ: Benin\n- BM: Bermuda\n- BT: Bhutan\n- BO: Bolivia, Plurinational State of\n- BO: Bolivia\n- BA: Bosnia and Herzegovina\n- BA: Bosnia\n- BA: Herzegovina\n- BW: Botswana\n- BV: Bouvet Island\n- BR: Brazil\n- IO: British Indian Ocean Territory\n- BN: Brunei Darussalam\n- BG: Bulgaria\n- BF: Burkina Faso\n- BI: Burundi\n- KH: Cambodia\n- CM: Cameroon\n- CA: Canada\n- CV: Cape Verde\n- KY: Cayman Islands\n- CF: Central African Republic\n- TD: Chad\n- CL: Chile\n- CN: China\n- CX: Christmas Island\n- CC: Cocos (keeling) Islands\n- CC: Cocos\n- CO: Colombia\n- KM: Comoros\n- CG: Congo\n- CD: Congo, the Democratic Republic of the\n- CK: Cook Islands\n- CR: Costa Rica\n- CI: Cote D'ivoire\n- HR: Croatia\n- CU: Cuba\n- CY: Cyprus\n- CZ: Czech Republic\n- DK: Denmark\n- DJ: Djibouti\n- DM: Dominica\n- DO: Dominican Republic\n- EC: Ecuador\n- EG: Egypt\n- SV: El Salvador\n- GQ: Equatorial Guinea\n- ER: Eritrea\n- EE: Estonia\n- ET: Ethiopia\n- FK: Falkland Islands (malvinas)\n- FK: Falkland Islands\n- FO: Faroe Islands\n- FJ: Fiji\n- FI: Finland\n- FR: France\n- GF: French Guiana\n- PF: French Polynesia\n- TF: French Southern Territories\n- GA: Gabon\n- GM: Gambia\n- GE: Georgia\n- DE: Germany\n- GH: Ghana\n- GI: Gibraltar\n- GR: Greece\n- GL: Greenland\n- GD: Grenada\n- GP: Guadeloupe\n- GU: Guam\n- GT: Guatemala\n- GG: Guernsey\n- GN: Guinea\n- GW: Guinea-bissau\n- GY: Guyana\n- HT: Haiti\n- HM: Heard Island and Mcdonald Islands\n- VA: Holy See (vatican City State)\n- VA: Vatican\n- HN: Honduras\n- HK: Hong Kong\n- HU: Hungary\n- IS: Iceland\n- IN: India\n- ID: Indonesia\n- IR: Iran, Islamic Republic of\n- IR: Iran\n- IQ: Iraq\n- IE: Ireland\n- IM: Isle of Man\n- IL: Israel\n- IT: Italy\n- JM: Jamaica\n- JP: Japan\n- JE: Jersey\n- JO: Jordan\n- KZ: Kazakhstan\n- KE: Kenya\n- KI: Kiribati\n- KP: Korea, Democratic People's Republic of\n- KR: Korea, Republic of\n- KR: Korea\n- KW: Kuwait\n- KG: Kyrgyzstan\n- LA: Lao People's Democratic Republic\n- LA: Lao\n- LV: Latvia\n- LB: Lebanon\n- LS: Lesotho\n- LR: Liberia\n- LY: Libyan Arab Jamahiriya\n- LI: Liechtenstein\n- LT: Lithuania\n- LU: Luxembourg\n- MO: Macao\n- MK: Macedonia, the Former Yugoslav Republic of\n- MK: Macedonia\n- MG: Madagascar\n- MW: Malawi\n- MY: Malaysia\n- MV: Maldives\n- ML: Mali\n- MT: Malta\n- MH: Marshall Islands\n- MQ: Martinique\n- MR: Mauritania\n- MU: Mauritius\n- YT: Mayotte\n- MX: Mexico\n- FM: Micronesia, Federated States of\n- FM: Micronesia\n- MD: Moldova, Republic of\n- MD: Moldova\n- MC: Monaco\n- MN: Mongolia\n- ME: Montenegro\n- MS: Montserrat\n- MA: Morocco\n- MZ: Mozambique\n- MM: Myanmar\n- NA: Namibia\n- NR: Nauru\n- NP: Nepal\n- NL: Netherlands\n- AN: Netherlands Antilles\n- NC: New Caledonia\n- NZ: New Zealand\n- NI: Nicaragua\n- NE: Niger\n- NG: Nigeria\n- NU: Niue\n- NF: Norfolk Island\n- MP: Northern Mariana Islands\n- NO: Norway\n- OM: Oman\n- PK: Pakistan\n- PW: Palau\n- PS: Palestinian Territory, Occupied\n- PS: Palestine\n- PA: Panama\n- PG: Papua New Guinea\n- PY: Paraguay\n- PE: Peru\n- PH: Philippines\n- PN: Pitcairn\n- PL: Poland\n- PT: Portugal\n- PR: Puerto Rico\n- QA: Qatar\n- RE: Reunion\n- RO: Romania\n- RU: Russian Federation\n- RW: Rwanda\n- BL: Saint Barthelemy\n- SH: Saint Helena, Ascension and Tristan Da Cunha\n- SH: Saint Helena\n- KN: Saint Kitts and Nevis\n- LC: Saint Lucia\n- MF: Saint Martin\n- PM: Saint Pierre and Miquelon\n- VC: Saint Vincent and the Grenadines\n- WS: Samoa\n- SM: San Marino\n- ST: Sao Tome and Principe\n- SA: Saudi Arabia\n- SN: Senegal\n- RS: Serbia\n- SC: Seychelles\n- SL: Sierra Leone\n- SG: Singapore\n- SK: Slovakia\n- SI: Slovenia\n- SB: Solomon Islands\n- SO: Somalia\n- ZA: South Africa\n- GS: South Georgia and the South Sandwich Islands\n- ES: Spain\n- LK: Sri Lanka\n- SD: Sudan\n- SR: Suriname\n- SJ: Svalbard and Jan Mayen\n- SZ: Swaziland\n- SE: Sweden\n- CH: Switzerland\n- SY: Syrian Arab Republic\n- TW: Taiwan, Province of China\n- TW: Taiwan\n- TJ: Tajikistan\n- TZ: Tanzania, United Republic of\n- TZ: Tanzania\n- TH: Thailand\n- TL: Timor-leste\n- TG: Togo\n- TK: Tokelau\n- TO: Tonga\n- TT: Trinidad and Tobago\n- TN: Tunisia\n- TR: Turkey\n- TM: Turkmenistan\n- TC: Turks and Caicos Islands\n- TV: Tuvalu\n- UG: Uganda\n- UA: Ukraine\n- AE: United Arab Emirates\n- GB: United Kingdom\n- GB: England\n- GB: Britain\n- GB: Great Britain\n- US: United States\n- US: United States of America\n- US: USA\n- UM: United States Minor Outlying Islands\n- UY: Uruguay\n- UZ: Uzbekistan\n- VU: Vanuatu\n- EE: Vatican City State See Holy\n- VE: Venezuela, Bolivarian Republic of\n- VE: Venezuela\n- VN: Viet Nam\n- VG: Virgin Islands, British\n- VI: Virgin Islands, U.S.\n- WF: Wallis and Futuna\n- EH: Western Sahara\n- YE: Yemen\n- ZM: Zambia\n- ZW: Zimbabwe",,,,,,,,,,,,,,,
^marker,,,M,"Marker labels a dict with typing information.\nSee [Kinds chapter]`docHaystack::Kinds#marker`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^val,,,M,"Data value type",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^scalar,[^val],,,"Scalar is an atomic value kind",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^na,[^scalar],,,"Not available used to indicate invalid or missing data.\nSee [Kinds chapter]`docHaystack::Kinds#na`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^remove,[^scalar],,,"Singleton for remove operation.\nSee [Kinds chapter]`docHaystack::Kinds#remove`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^bool,[^scalar],,,"Boolean value 'true' or 'false'.\nSee [Kinds chapter]`docHaystack::Kinds#bool`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^number,[^scalar],,,"Integer or floating point numbers annotated with an optional unit.\nSee [Kinds chapter]`docHaystack::Kinds#number`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^str,[^scalar],,,"Unicode string of characters.\nSee [Kinds chapter]`docHaystack::Kinds#str`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^uri,[^scalar],,,"Universal resource identifier.\nSee [Kinds chapter]`docHaystack::Kinds#uri`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ref,[^scalar],,,"Reference to an entity. Ref values are ASCII strings limited to the\nfollowing chars: a-z, A-Z, 0-9, underbar, colon, dash, dot, or tilde.\nSee [Kinds chapter]`docHaystack::Kinds#ref`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^symbol,[^scalar],,,"Symbol to a def. Symbol values are ASCII strings limited to the\nfollowing chars: a-z, A-Z, 0-9, underbar, colon, dash, dot.\nSee [Kinds chapter]`docHaystack::Kinds#symbol`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^date,[^scalar],,,"ISO 8601 date as year, month, day: '2011-06-07'.\nSee [Kinds chapter]`docHaystack::Kinds#date`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^time,[^scalar],,,"ISO 8601 time as hour, minute, seconds: '09:51:27.354'.\nSee [Kinds chapter]`docHaystack::Kinds#time`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dateTime,[^scalar],,,"ISO 8601 timestamp followed by timezone identifier.\nSee [Kinds chapter]`docHaystack::Kinds#dateTime`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^coord,[^scalar],,,"Geographic coordinate in latitude/longitude in decimal degrees.\nSee [Kinds chapter]`docHaystack::Kinds#coord`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^xstr,[^scalar],,,"Extended string - type name and string value encoding.\nSee [Kinds chapter]`docHaystack::Kinds#xstr`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^list,[^val],,,"Ordered list of zero or more values.\nSee [Kinds chapter]`docHaystack::Kinds#list`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dict,[^val],,,"Map of name/value tag pairs.\nSee [Kinds chapter]`docHaystack::Kinds#dict`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^grid,[^val],,,"Two dimension table of columns and rows.\nSee [Kinds chapter]`docHaystack::Kinds#grid`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^int,[^number],,,"Unitless integer number",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^duration,[^number],,,"Number with a unit of time",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^maxVal,[^number],,,"Inclusive maximum for a numeric value.",^lib:ph,[^def,^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^minVal,[^number],,,"Inclusive minimum for a numeric value.",^lib:ph,[^def,^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^span,[^xstr],,,"Time span as modeled encoded as XStr.  This is a placeholder\nto eventually formalize the time range used by hisRead op.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^of,[^symbol],,,"Expected value type of a collection, reference, or choice",^lib:ph,[^def],,,,,,,,,,,,,,,,,,,,,,,,,,
^lib:ph,[^lib],,,"Project Haystack core definitions",^lib:ph,,,,,,,,,,,,,"3.9.15",`https://project-haystack.org/def/ph/`,,,,,,,,,,,,,
^accumulate,[^marker],,,"Accumulate the tag's value during [inheritance]`docHaystack::Normalization#inherit`\nand [defx]`docHaystack::Normalization#defx`.  Tags marked as accumulate\nare aggregated together during normalization and deduplicated.  This\nmarker must only be used on tags which expect a list value.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^baseUri,[^uri],,,"Base URI for normalizing relative URIs",^lib:ph,[^lib],,,,,,,,,,,,,,,,,,,,,,,,,,
^children,[^list],^dict,,"List of prototypes contained by this entity.\nSee [Protos chapter]`docHaystack::Protos` for more details.",^lib:ph,,,M,,,,,,,,,,,,,,,,,,,,,,,,
^childrenFlatten,[^list],^symbol,,"List of aspects to flatten into children prototypes.\nSee [Protos chapter]`docHaystack::Protos` for more details.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^choice,[^marker],,M,"Choice specifies an exclusive marker selection.\nSee [Choices]`docHaystack::Choices` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^computedFromReciprocal,[^marker],,,"Indicates a relationship that is computed from its reciprocal.\nComputed defs cannot be used as tags themselves.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^def,[^symbol],,,"Create a new definition bound to the given symbol.\nSee [Defs chapter]`docHaystack::Defs`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^defx,[^symbol],,,"Extends the given definition with additional meta tags.\nSee [Normalization]`docHaystack::Normalization#defx`.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^doc,[^str],,,"Documentation in simplified flavor of markdown.  The first\nsentence up to the period is used as the summary.\nSpecific formatting options:\npre>\n// inline formatting\n*italic*           // italics font\n**bold**           // bold font\n'code'             // code or API term\n`point`            // hyperlink to def (code link)\n[text]`point`      // hyperlink with explicit link text\n![alt]`image.png`  // image\n// unordered list\n- one\n- two\n- three\n// ordered list; use numbers or letters\n1. one\n2. two\n3. three\n<pre\nThe main difference between markdown is that inline code uses single\nticks and hyperlinks are annotated using the backtick.  Links may be:\n- absolute http/https URIs\n- def symbol such as \"site\" or \"hot-water\"",^lib:ph,[^def],,,,,,,,,,,,,,,,,,,,,,,,,,
^docAssociations,[^marker],,,"Generate a section in the docs for this association.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^docTaxonomy,[^marker],,,"Generate a taxonomy tree for this term in the documentationindex.\nWhen applied to a def, then it will will be listed in the docs\nunder the [taxonomies]`docHaystack::Docs#taxonomies` section.",^lib:ph,,M,,,,,,,,,,,,,,,,,,,,,,,,,
^enum,[^val],,,"Defines an eumeration of string key names.  The range may also be applied\nto format a Bool ordered as \"false,true\".  The value of this tag may be\nformatted in one of five ways:\n- dict of dicts keyed by name and Dict values for meta such as 'doc' tag\n- comma separated names on one line\n- names separated by a \"\\n\" newline character\n- markdown unordered list formatted as a series of \"- name: description\\n\"\n- ref to a Xeto 'sys::Enum' spec\nEnum names *should* follow valid tag naming rules (start with lowercase\nASCII letter and contain only ASCII letters and numbers).  However in\ncases where mapping directly to external enumerations enum names can\ncontain arbitrary characters such as space.",^lib:ph,[^def,^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^feature,,,M,"Feature namespace of definitions formatted as 'feature:name'",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^lib,[^feature],,,"Library module of symbolic definitions.\nSee `docHaystack::Namespaces#libs` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^depends,[^list],^ref,,"List of this library's dependencies.  The dependent libs define the\n[lib namespace]`docHaystack::Namespaces#lib`. Also see\n[Normalization]`docHaystack::Normalization#resolve`.",^lib:ph,[^lib],,,,,,,,,,,,,,,,,,,,,,,,,,
^mandatory,[^marker],,,"Requires that the marker be applied to dicts which use the marker's subtypes.\nThis tag is typically applied to top-level entity tags such as 'equip'.\nFor example if an instance is tagged with a subtype of 'equip' such\nas 'tank', then the instance must also include the 'equip' tag as a\nmandatory marker.",^lib:ph,[^def],M,,,,,,,,,,,,,,,,,,,,,,,,,
^notInherited,[^marker],,,"Marker applied to a def to indicate that is not inherited into\nsubtype definitions.",^lib:ph,[^def],,,,,,,,,,,,,,,,,,,,,,,,,,
^openEnum,[^marker],,,"Apply to str enum tags where the enumeration range is open ended.\nUser interfaces should support data entry for arbitrary strings, but\nalso provide a dropdown for the predefined enumeration.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^transient,[^marker],,,"Indicates a value tag which should not be persisted.  Transient\nvalues often change frequently and do not provide long term informational\nvalue. Typyically they are stored only in RAM and should not be stored\nto durable storage.",^lib:ph,[^def],,,,,,,,,,,,,,,,,,,,,,,,,,
^version,[^str],,,"Version string formatted as decimal integers separated by a dot",^lib:ph,[^lib],,,,,,,,,,,,,,,,,,,,,,,,,,
^wikipedia,[^uri],,,"Hyperlink to the subject's page on Wikipedia",^lib:ph,[^def],,,,,,,,,,,,,,,,,,,,,,,,,,
^deprecated,[^marker],,,"Obsoleted",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^filterStr,[^str],,,"Haystack filter string.  See `docHaystack::Filters`",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^kind,[^str],,,"Kind name used to identity a value data type",^lib:ph,[^point],,,,,,,,,,,"- Marker: is-a label\n- Bool: true or false\n- NA: not available\n- Number: floating point with optional unit\n- Str: Unicode string\n- Uri: Universal resource identifier\n- Ref: reference to an entity\n- Date: an ISO 8601 date as year, month, day: 2011-06-07\n- Time: an ISO 8601 time as hour, minute, seconds: 09:51:27.354\n- DateTime: an ISO 8601 timestamp followed by timezone name\n- Coord: geographic coordinate in latitude/longitude formatted as C(lat,lng)\n- XStr: extended string with type name\n- List: ordered sequence\n- Dict: key/value map\n- Grid: two dimensional tabular data collection",,,,,,,,,,,,,,,
^max,[^marker],,,"Maximum",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^min,[^marker],,,"Minimum",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^nodoc,[^marker],,,"Undocumented and not officially supported",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^nosrc,[^marker],,,"Do not include source code in documentation",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^tz,[^str],,,"Timezone identifier from standard [timezone database]`docHaystack::TimeZones`",^lib:ph,[^point,^site,^weatherStation],,,,,,,,,,,,,,,,,,,,,,,,,,
^unit,[^str],,,"Unit identifier from standard unit database",^lib:ph,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^op,[^feature],,,"Operation for HTTP API.\nSee `docHaystack::Ops` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^noSideEffects,[^marker],,,"Marks a function or operation as having no side effects.  The function\nmay or may not be *pure* in that calling it multiple times with the\nsame arguments always evaluates to the same result.",^lib:ph,,,,,,,,,,`https://en.wikipedia.org/wiki/Side_effect_(computer_science)`,,,,,,,,,,,,,,,,,
^op:about,[^op],,,"Query basic information about the server.\nSee `docHaystack::Ops#about` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:close,[^op],,,"Close the current session and cancel the auth bearer token.\nSee `docHaystack::Ops#close` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^op:defs,[^op],,,"Query the definitions in the current namespace.\nSee `docHaystack::Ops#defs` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:filetypes,[^op],,,"Query the filetype defs in the current namespace.\nSee `docHaystack::Ops#filetypes` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:libs,[^op],,,"Query the lib defs in the current namespace.\nSee `docHaystack::Ops#libs` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:read,[^op],,,"Query the a set of entity records by id or by filter.\nSee `docHaystack::Ops#read` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:ops,[^op],,,"Query the op defs in the current namespace.\nSee `docHaystack::Ops#ops` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:nav,[^op],,,"Query the navigation tree for discovery.\nSee `docHaystack::Ops#nav` chapter.",^lib:ph,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:watchPoll,[^op],,,"Poll a watch subscription.\nSee `docHaystack::Ops#watchPoll` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^op:watchSub,[^op],,,"Subscribe to entity data.\nSee `docHaystack::Ops#watchSub` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^op:watchUnsub,[^op],,,"Unsubscribe to entity data.\nSee `docHaystack::Ops#watchUnsub` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^relationship,[^symbol],,M,"Ref tags used to model entity-to-entity relationships.\nSee [Relationships]`docHaystack::Relationships` chapter.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^transitive,[^marker],,,"This marker is applied to a `relationship` to indicate it is transitive.\nTransitivity requires that if the relationship applies to A,B and B,C\nthen it also applies to A,C.",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^containedBy,[^relationship],,,"The entity is logically contained by the referent.",^lib:ph,,,,^contains,,,,,,,,,,,,M,,,,,,,,,,,
^contains,[^relationship],,,"Entities logically contained by this entity",^lib:ph,,,,^containedBy,M,,,,,,,,,,,M,,,,,,,,,,,
^inputs,[^relationship],,,"The entity inputs a substance from the referent.\nThe value of this tag is what is received.",^lib:ph,,,,^outputs,,,,,,,,,,,,M,,,,,,,,,,,
^outputs,[^relationship],,,"The entity outputs a substance to the referent.\nThe value of this tag is what is supplied.",^lib:ph,,,,^inputs,,,,,,,,,,,,M,,,,,,,,,,,
^input,[^marker],,,"Entity inputs a substance which flows from another entity",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^output,[^marker],,,"Entity outputs a substance with flows to other entities",^lib:ph,,,,,,,,,,,,,,,,,,,,,,,,,,,
^air,[^gas],,,"The mixture of gases which surrounds the earth",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Atmosphere_of_Earth`,,,,,,,,,,,,,,,,,
^ch2o,[^gas],,,"Formaldehyde (CH\u2082O)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Formaldehyde`,,,,,,,,,,,,,,,,,
^ch4,[^gas],,,"Methane (CH\u2084)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Methane`,,,,,,,,,,,,,,,,,
^co,[^gas],,,"Carbon monoxide (CO)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Carbon_monoxide`,,,,,,,,,,,,,,,,,
^co2,[^gas],,,"Carbon dioxide (CO\u2082)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Carbon_dioxide`,,,,,,,,,,,,,,,,,
^hfc,[^gas],,,"Hydrofluorocarbons",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Hydrofluorocarbon`,,,,,,,,,,,,,,,,,
^n2o,[^gas],,,"Nitrous oxide (N\u2082O)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Nitrous_oxide`,,,,,,,,,,,,,,,,,
^nf3,[^gas],,,"Nitrogen trifluoride (NF\u2083)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Nitrogen_trifluoride`,,,,,,,,,,,,,,,,,
^nh3,[^gas],,,"Ammonia (NH\u2083)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Ammonia`,,,,,,,,,,,,,,,,,
^no2,[^gas],,,"Nitrogen dioxide (NO\u2082)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Nitrogen_dioxide`,,,,,,,,,,,,,,,,,
^o2,[^gas],,,"Oxygen (O\u2082) - the common dioxygen allotrope in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Oxygen`,,,,,,,,,,,,,,,,,
^o3,[^gas],,,"Ozone (O\u2083)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Ozone`,,,,,,,,,,,,,,,,,
^pfc,[^gas],,,"Perfluorocarbons",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Fluorocarbon`,,,,,,,,,,,,,,,,,
^pm01,[^solid],,,"Particulate matter 0.1; atmospheric pollutant of fine particles with an aerodynamic diameter of 0.1 micrometers or less",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Particulates`,,,,,,,,,,,,,,,,,
^pm25,[^solid],,,"Particulate matter 2.5; atmospheric pollutant of fine particles with an aerodynamic diameter of 2.5 micrometers or less",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Particulates`,,,,,,,,,,,,,,,,,
^pm10,[^solid],,,"Particulate matter 10; atmospheric pollutant of fine particles with an aerodynamic diameter of 10 micrometers or less",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Particulates`,,,,,,,,,,,,,,,,,
^sf6,[^gas],,,"Sulphur hexafluoride (SF\u2086)",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Sulfur_hexafluoride`,,,,,,,,,,,,,,,,,
^tvoc,[^gas],,,"Total volatile organic compound (TVOC).",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Volatile_organic_compound`,,,,,,,,,,,,,,,,,
^air-temp,[^temp],,,"Dry bulb temperature",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Temperature`,,,,,,,[^air],["\u00b0C","\u00b0F"],,,,,,,,,
^air-velocity,[^quantity],,,"Rate of air movement as distance over time",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["m/sec","ft/min"],,,,,,,,,
^wetBulb,[^quantity],,,"Wet bulb air temperature.  Temperature which the air would have if cooled to saturation by the evaporation of water into it.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["\u00b0C","\u00b0F"],,,,,,,,,
^feelsLike,[^quantity],,,"Apparent temperature perceived when considering humidity, wind chill, and heat index",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["\u00b0C","\u00b0F"],,,,,,,,,
^dewPoint,[^quantity],,,"Dew point temperature at which water vapor will form dew",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["\u00b0C","\u00b0F"],,,,,,,,,
^humidity,[^quantity],,,"Percent relative humidity; measure of moisture in the air",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["%RH"],,,,,,,,,
^enthalpy,[^quantity],,,"Total heat content of a system. It is defined as internal energy of the system plus the product of pressure and volume.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kJ/kg","BTU/lb"],,,,,,,,,
^airQuality,[^concentration],,,"Concentration of contaminants in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],,,,,,,,,,
^ch2o-concentration,[^airQuality],,,"Concentration of formaldehyde (CH\u2082O) in the air.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^co-concentration,[^airQuality],,,"Concentration of carbon monoxide (CO) in the air.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["ppm"],,,,,,,,,
^co2-concentration,[^airQuality],,,"Concentration of carbon dioxide (CO\u2082) in the air.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["ppm"],,,,,,,,,
^nh3-concentration,[^airQuality],,,"Concentration of ammonia (NH\u2083) in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^no2-concentration,[^airQuality],,,"Concentration of nitrogen dioxide (NO\u2082) in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^o3-concentration,[^airQuality],,,"Concentration of ozone (O\u2083) in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["ppm"],,,,,,,,,
^pm01-concentration,[^airQuality],,,"Concentration of particulate matter 0.1 in the air.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^pm25-concentration,[^airQuality],,,"Concentration of particulate matter 2.5 in the air.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^pm10-concentration,[^airQuality],,,"Concentration of particulate matter 10 in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^tvoc-concentration,[^airQuality],,,"Concentration of total volatile organic compounds (TVOC) in the air",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^air],["\u00b5g/m\u00b3","ppb"],,,,,,,,,
^emission,[^quantity],,,"Amount of a substance discharged into the air",^lib:phScience,,,,,,,,,,,,,,,,,[^air],,,,,,,,,,
^ch4-emission,[^emission],,,"Greenhouse gas emission of methane (CH\u2084) into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^co2-emission,[^emission],,,"Greenhouse gas emission of carbon dioxide (CO\u2082) into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^hfc-emission,[^emission],,,"Greenhouse gas emission of hydrofluorocarbons into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^n2o-emission,[^emission],,,"Greenhouse gas emission of nitrous oxide (N\u2082O) into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^nf3-emission,[^emission],,,"Greenhouse gas emission of nitrogen trifluoride (NF\u2083) into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^pfc-emission,[^emission],,,"Greenhouse gas emission of perfluorocarbons into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^sf6-emission,[^emission],,,"Greenhouse gas emission of sulphur hexafluoride (SF\u2086) into the air.",^lib:phScience,,,,,,,,,,,,,,,,,[^air],["kg","ton","lb"],,,,,,,,,
^lib:phScience,[^lib],,,"Project Haystack scientific definitions",^lib:phScience,,,,,,,,,,,,,"3.9.15",`https://project-haystack.org/def/phScience/`,,,,,[^lib:ph],,,,,,,,
^angle,[^marker],,,"Measurement of the relative difference in direction between two vectors or phasors",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^avg,[^marker],,,"Average; central or typical value; median",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^apparent,[^marker],,,"Perceived quantity",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^atmospheric,[^marker],,,"Related to the atmosphere of the earth",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^co2e,[^marker],,,"Carbon dioxide equivalent",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Global_warming_potential`,,,,,,,,,,,,,,,,,
^current,[^marker],,,"Movement of fluid or electricity",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^flux,[^marker],,,"Measurement through a given surface",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^intensity,[^marker],,,"Measure of an electromagnetic field",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^luminous,[^marker],,,"Relating to light as perceived by the eye",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^magnitude,[^marker],,,"Size or extent",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^quality,[^marker],,,"Quantity measured against standard metric",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^total,[^marker],,,"Complete or absolute",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^velocity,[^marker],,,"Speed in a given direction",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^volt,[^marker],,,"Electrical potential difference or electromotive force.",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^phenomenon,[^marker],,M,"Aspect of scientific interest with measurable quantities",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^elec,[^phenomenon],,,"Associated with electricity or with electrical force, power, or energy.\nThis is often opposed to `mech` mechanical energy.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Electricity`,,,,,,,,,,,,,,,,,
^light,[^phenomenon],,,"Electromagnetic radiation in the visible spectrum",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Light`,,,,,,,,,,,,,,,,,
^solar,[^phenomenon],,,"Relating to energy from the sun",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^wind,[^phenomenon],,,"Flow of air on surface of the Earth",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Wind`,,,,,,,,,,,,,,,,,
^weather,[^phenomenon],,,"Associated with atmospheric air or phenomenon.\nSee `docHaystack::Weather` chapter.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Weather`,,,,,,,,,,,,,,,,,
^quantity,[^marker],,M,"Measurable property of a substance or phenomenon",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^quantityOf,[^association],^phenomenon,,"Associates quantity as measurement of a phenomenon",^lib:phScience,,,,^quantities,,,,,,,,,,,,,,,,,,,,,,,
^quantities,[^association],^symbol,,"Quantities used to measure this phenomenon",^lib:phScience,,,,^quantityOf,M,M,,,,,,,,,,,,,,,,,,,,,
^prefUnit,[^list],^unit,,"Defines a preferred unit to be used with a quantity",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^concentration,[^quantity],,,"Abundance of substance in the total volume of a mixture.",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Concentration`,,,,,,,[^substance],,,,,,,,,,
^temp,[^quantity],,,"Temperature - measure of hot and cold",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Temperature`,,,,,,,[^substance],["\u00b0C","\u00b0F"],,,,,,,,,
^volume,[^quantity],,,"Three dimensional space occupied by a substance",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Volume`,,,,,,,[^substance],["m\u00b3","ft\u00b3","L","gal"],,,,,,,,,
^pressure,[^quantity],,,"Measure of force applied",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Pressure`,,,,,,,[^fluid],["kPa","psi"],,,,,,,,,
^flow,[^quantity],,,"Measure of volumetric flow of fluid",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Fluid_dynamics`,,,,,,,[^fluid],["m\u00b3/s","gal/min"],,,,,,,,,
^level,[^quantity],,,"Range from 0% to 100%.  When paired with a fluid this implies a fill\nlevel where 0% is empty and 100% is full.",^lib:phScience,,,,,,,,,,,,,,,,,[^fluid],["%"],,,,,,,,,
^atmospheric-pressure,[^pressure],,,"Barometric pressure exerted by the weight of the atmosphere",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Pressure`,,,,,,,[^weather],["millibar","inHg"],,,,,,,,,
^cloudage,[^quantity],,,"Percentage of sky obscured by clouds. This is also known as cloudiness, or cloud amount.",^lib:phScience,,,,,,,,,,,,,,,,,[^weather],["%"],,,,,,,,,
^daytime,[^quantity],,,"Time between sunrise and sunset",^lib:phScience,,,,,,,,,,,,"- nighttime: false indicates sun is below horizon\n- daytime: true indicates sun is above horizon",,,,,[^weather],,,,,,,,,,
^precipitation,[^quantity],,,"Amount of atmospheric water vapor fallen including rain, sleet, snow, and hail",^lib:phScience,,,,,,,,,,,,,,,,,[^weather],["mm","in"],,,,,,,,,
^solar-irradiance,[^irradiance],,,"Energy received on surface of the earth from the sun",^lib:phScience,,,,,,,,,,,,,,,,,[^solar],["W/m\u00b2"],,,,,,,,,
^weatherCond,[^quantity],,,"Enumeration of weather conditions",^lib:phScience,,,,,,,,,,,,"unknown\nclear\npartlyCloudy\ncloudy\nshowers\nrain\nthunderstorms\nice\nflurries\nsnow",,,,,[^weather],,,,,,,,,,
^wind-speed,[^speed],,,"Wind flow speed",^lib:phScience,,,,,,,,,,,,,,,,,[^wind],["km/h","mph"],,,,,,,,,
^wind-direction,[^direction],,,"Compass direction from which wind originates",^lib:phScience,,,,,,,,,,,,,,,,,[^wind],["deg"],,,,,,,,,
^visibility,[^quantity],,,"Distance at which light can be clearly discerned",^lib:phScience,,,,,,,,,,,,,,,,,[^weather],["km","mile"],,,,,,,,,
^elec-power,[^power],,,"Electrical energy consumed per unit time",^lib:phScience,,,,,,,,,,,,,,,,,[^elec],["kW"],,,,,,,,,
^elec-energy,[^energy],,,"Electrical energy consumed",^lib:phScience,,,,,,,,,,,,,,,,,[^elec],["kWh"],,,,,,,,,
^elec-volt,[^quantity],,,"Electrical voltage, potential difference",^lib:phScience,,,,,,,,,,,,,,,,,[^elec],,,,,,,,,,
^elec-current,[^quantity],,,"Electrical current",^lib:phScience,,,,,,,,,,,,,,,,,[^elec],,,,,,,,,,
^illuminance,[^quantity],,,"Luminous flux hitting the inside of the sphere at a specific point.\nAlso see [ies.org]`https://www.ies.org/definitions/illuminance/`",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Illuminance`,,,,,,,[^light],["lux","footcandle","phot"],,,,,,,,,
^light-level,[^level],,,"Sensed or controlled dimming level of electrical lighting.\nLevel is measured as a percentage where 0% is off and 100%\nis full brightness.",^lib:phScience,,,,,,,,,,,,,,,,,[^light],["%"],,,,,,,,,
^luminance,[^quantity],,,"Energy of light in a given direction.\nAlso see [ies.org]`https://www.ies.org/definitions/luminance/`",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Luminance`,,,,,,,[^light],["candelas_per_square_meter","candelas_per_square_foot"],,,,,,,,,
^luminous-flux,[^quantity],,,"Total perceived light in all directions.\nAlso see [ies.org]`https://www.ies.org/definitions/luminous-flux/`",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Luminous_flux`,,,,,,,[^light],["lumen"],,,,,,,,,
^luminous-intensity,[^quantity],,,"Perceived light in a particular direction per unit solid angle.\nAlso see [ies.org]`https://www.ies.org/definitions/luminous-intensity/`",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Luminous_intensity`,,,,,,,[^light],["candela"],,,,,,,,,
^direction,[^quantity],,,"Compass direction measured in degrees: North: 0\u00b0 = 360\u00b0, East: 90\u00b0, South: 180\u00b0, West: 270\u00b0",^lib:phScience,,,,,,,,,,,,,,,,,,["deg"],,,,,,,,,
^energy,[^quantity],,,"Measure of ability to do work",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^freq,[^quantity],,,"Occurrences per unit time",^lib:phScience,,,,,,,,,,,,,,,,,,["Hz"],,,,,,,,,
^irradiance,[^quantity],,,"Energy received at a surface by area",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^power,[^quantity],,,"Energy consumed per unit time",^lib:phScience,,,,,,,,,,,,,,,,,,,,,,,,,,,
^speed,[^quantity],,,"Distance per unit time",^lib:phScience,,,,,,,,,,,,,,,,,,["km/h","mph"],,,,,,,,,
^substance,[^phenomenon],,,"Matter in one the three states solid, liquid, or gas",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Matter`,,,,,,,,,,,,,,,,,
^solid,[^substance],,,"Substance with definite shape and volume",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Solid`,,,,,,,,,,,,,,,,,
^fluid,[^substance],,,"Liquid or gas",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Fluid`,,,,,,,,,,,,,,,,,
^liquid,[^fluid],,,"Substance with definite volume but takes the shape of its container",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Liquid`,,,,,,,,,,,,,,,,,
^gas,[^fluid],,,"Substance with neither definite volume nor shape",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Gas`,,,,,,,,,,,,,,,,,
^ice,[^solid],,,"Water in its solid form",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Ice`,,,,,,,,,,,,,,,,,
^water,[^liquid],,,"Water in its liquid form",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^steam,[^gas],,,"Water in its gas form",^lib:phScience,,,,,,,,,,`https://en.wikipedia.org/wiki/Steam`,,,,,,,,,,,,,,,,,
^actuator,[^equip,^elec-input],,,"Equipment to move or control a mechanism.  Actuators may be manually\noperated or automated via a control system to convert an energy source\ninto mechanical energy.  Typically the energy source is electricity,\nhydraulics, or pneumatics.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Actuator`,,,,,,,,,,[{equip},{point}],,,,,,,
^damper,[^marker],,,"Damper equipment or control point.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Damper_(flow)`,,,,,,,,,,,,,,,,,
^damper-actuator,[^actuator],,,"Actuator to regulate the flow of air.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Damper_(flow)`,,,,,,,,,,[{damper cmd point},{damper sensor point},{equip},{point}],[^ductSection],,,,,,
^valve,[^marker],,,"Valve equipment or control point",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Valve`,,,,,,,,,,,,,,,,,
^valve-actuator,[^actuator],,,"Actuator to regulate the flow of fluid.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Valve`,,,,,,,,,,[{valve cmd point},{valve sensor point},{equip},{point}],[^fluid,^pipeSection],,,,,,
^airHandlingEquip,[^equip,^air-output,^elec-input],,,"HVAC equipment that conditions and delivers air via one or more fans.\nConditioning of air includes heating, cooling, humidification,\ndehumidification, and ventilation. See `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Air_handler`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,,,,,,
^ahu,[^airHandlingEquip],,,"Air Handling Unit: An enclosure with a fan that delivers air to a space\nvia ductwork and performs one or more of the functions of cleaning,\nheating, cooling, humidifying, dehumidifying, ventilating or circulating\nthe air.  See `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Air_handler`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,M,,,,,
^doas,[^ahu],,,"Dedicated Outside Air System: An AHU that brings in 100% outside air and\nno recirculated air in order to provide ventilation to spaces.\nSee `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Air_handler`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,,,,,,
^mau,[^doas],,,"Makeup Air Unit: A DOAS that provides make-up air for a separate, dedicated\nexhaust system. That is, this equip does not contain an exhaust air section.\nSee `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Air_handler`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,,,,,,
^rtu,[^ahu],,,"Roof Top Unit: A unitary AHU that is weatherized for outdoor use.\nSee `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Air_handler`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,,,,,,
^fcu,[^airHandlingEquip],,,"Fan Coil Unit: A unitary, factory-made enclosure with a fan and coil\nthat recirculates air in a space and performs one or more of the\nfunctions of cleaning, heating, cooling, humidifying, dehumidifying,\nor ventilating the air. Unit heaters are examples of FCUs.\nSee `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fan_coil_unit`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,M,,,,,
^unitVent,[^fcu],,,"Unit Ventilator: An FCU that has direct access to outside air to provide\nthe space with ventilation.  See `docHaystack::AHUs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fan_coil_unit`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,,,,,,
^crac,[^fcu],,,"Computer Room Air Conditioner: An FCU designed to condition a computer\nroom.  See `docHaystack::AHUs` and `docHaystack::DataCenters` chapters.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fan_coil_unit`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point},{equip},{point}],,,,,,,
^airVolumeAdjustability,[^choice],,,"Ability of air handling equip to adjust volume of air flow",^lib:phIoT,[^airHandlingEquip],,,,,,,,,,,,,,,,,,,,,,,,,,
^constantAirVolume,[^airVolumeAdjustability],,,"Delivers a constant volume of air flow.  Typically this means\nequipment with a single speed fan.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^variableAirVolume,[^airVolumeAdjustability],,,"Delivers a variable volume of air flow.   Most variable volume systems\nare powered by a VFD fan. However other techniques such as inlet vanes\nmay be used in older systems.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ahuZoneDelivery,[^choice],,,"AHU delivery method of conditioned air to the zone",^lib:phIoT,[^airHandlingEquip],,,,,,,,,,,,,,,,,,,,,,,,,,
^directZone,[^ahuZoneDelivery],,,"AHU supplies air directly to the zone",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^vavZone,[^ahuZoneDelivery],,,"AHU supplies air to VAV terminal units",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^chilledBeamZone,[^ahuZoneDelivery],,,"AHU supplies air to chilled beam terminal units",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^multiZone,[^ahuZoneDelivery],,,"AHU discharge air is split into a duct per zone",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^humidifier-equip,[^equip],,,"Equipment which adds moisture to air to increase humidity",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Humidifier`,,,,,,,,,,[{humidifier run cmd point},{humidifier enable cmd point},{equip},{point}],[],,,,,,
^airTerminalUnit,[^equip,^air-input,^air-output,^elec-input],,,"Equipment in air distribution systems which terminate at the space.\nTerminal units receive air from `airHandlingEquip` which have the\nprimarily responsibility to condition air.  Terminal units are primarily\nresponsible for delivery of air to the space and tempering the temperature.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{thermostat equip},{discharge duct equip},{inlet duct equip},{equip},{point}],,,,,,,
^ates,[^equip],,,"Aquifer Thermal Energy Storage system.\nSee `docHaystack::ATES` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Aquifer_thermal_energy_storage`,,,,,,,,,,[{warm well equip},{cool well equip},{infiltration well equip},{extraction well equip},{flowInverter equip},{warm water flow thermal meter equip},{cool water flow thermal meter equip},{heatExchanger equip},{ground water flow sensor point},{ground water volume sensor point},{ground water pressure sensor point},{purge water flow sensor point},{purge water volume sensor point},{equip},{point}],,,,,,,
^well,[^equip],,,"A well is a source of groundwater and potentially thermal energy.  When\nused within an [ATES]`docHaystack::ATES` system, the well facilitates thermal\nenergy exchange with the ground warm and cool water sources. In this case, a\nwell can be either a closed system that transports water through pipes in the\nground, or an open system that pumps up and returns ground water.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{water temp sensor point},{water flow sensor point},{water volume sensor point},{water pressure sensor point},{water level sensor point},{water pump motor equip},{equip},{point}],,,,,,,
^flowInverter,[^equip],,,"System to change direction of substance flow ",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^atesDesign,[^choice],,,"Design type of the ATES underground system.",^lib:phIoT,[^ates],,,,,,,,,,,,,,,,,,,,,,,,,,
^atesMono,[^atesDesign],,,"The ATES has only one physical well.  This well is deep enough\nto penetrate two layers of groundwater.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^atesDoublet,[^atesDesign],,,"The ATES has one or more pairs of a separate warm and cool well.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^atesDoubletPaired,[^atesDesign],,,"The ATES is as a doublet, but with specific warm and cool wells linked together.\nThese linked wells do not exchange water with other wells.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^atesUnidirectional,[^atesDesign],,,"Similar to a doublet, but water always flows in the same direction from\nthe extraction to the infiltration well.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^atesClosedLoop,[^atesDesign],,,"The ATES uses closed piping to transport a water/glycol mixture\nthrough the ground. The system works like a heat exchanger; there\nis no ground water transported.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^battery,[^equip,^elec-output],,,"Equipment used to store electric energy",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Electric_battery`,,,,,,,,,,[{equip},{point}],,,,,,,
^boiler,[^equip,^elec-input],,,"Equipment to generate hot water or steam for heating",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Boiler`,,,,,,,,,,[{alarm sensor point},{equip},{point}],,,,,,,
^hot-water-boiler,[^boiler,^hot-water-output],,,"Boiler which outputs hot water",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Boiler`,,,,,,,,,,[{hot water leaving pipe equip},{hot water entering pipe equip},{makeup water entering pipe equip},{circ pipe equip},{outside duct equip},{flue duct equip},{alarm sensor point},{equip},{point}],,,,,,,
^steam-boiler,[^boiler,^steam-output],,,"Boiler which outputs steam",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Boiler`,,,,,,,,,,[{steam leaving pipe equip},{condensate entering pipe equip},{makeup water entering pipe equip},{circ pipe equip},{outside duct equip},{flue duct equip},{alarm sensor point},{equip},{point}],,,,,,,
^cav,[^airTerminalUnit],,,"Constant air volume terminal unit.  CAV systems use a constant\nair flow rate with a variable air temperature.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Constant_air_volume`,,,,,,,,,,[{thermostat equip},{discharge duct equip},{inlet duct equip},{equip},{point}],,,,,,,
^chiller,[^equip,^elec-input],,,"Equipment to remove heat from a liquid.  Chillers typically use a vapor\ncompression or an absorption refrigeration cycle.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Chiller`,,,,,,,,,,[{run cmd point},{enable cmd point},{run sensor point},{enable sensor point},{load cmd point},{load sensor point},{efficiency sensor point},{alarm sensor point},{chilled water leaving pipe equip},{chilled water entering pipe equip},{chilled water delta temp sensor point},{chilled water delta flow sensor point},{chilled water valve isolation cmd point},{condenser water leaving pipe equip},{condenser water entering pipe equip},{condenser water valve isolation cmd point},{condenser run cmd point},{condenser run sensor point},{condenser refrig temp sensor point},{condenser refrig pressure sensor point},{evaporator refrig temp sensor point},{evaporator refrig pressure sensor point},{equip},{point}],,,,,,,
^coolingCapacity,[^number],,,"Measurement of a chiller ability to remove heat measured",^lib:phIoT,[^chiller],,,,,,,,,,,,,,,,,["tonref","BTU/h","kW"],,,,,,,,,
^chillerMechanism,[^choice],,,"Primary mechanism of chiller",^lib:phIoT,[^chiller],,,,,,,,,,,,,,,,,,,,,,,,,,
^chiller-absorption,[^absorption,^chillerMechanism],,,"Cooling process using energy from heat source such as hot water",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Absorption_refrigerator`,,,,,,,,,,,,,,,,,
^chiller-reciprocal,[^reciprocal,^chillerMechanism],,,"Piston compressor driven by a crankshaft",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Reciprocating_compressor`,,,,,,,,,,,,,,,,,
^chiller-rotaryScrew,[^rotaryScrew,^chillerMechanism],,,"Rotary screw compression",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Rotary-screw_compressor`,,,,,,,,,,,,,,,,,
^chiller-centrifugal,[^centrifugal,^chillerMechanism],,,"Compression via a continuous flow of fluid through an impeller",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Centrifugal_compressor`,,,,,,,,,,,,,,,,,
^efficiency,[^marker],,,"Efficiency point of a chiller measured in \"COP\" or \"kW/ton\".",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^load,[^marker],,,"Chiller point to command or measure the chiller's load as a percentage\nfrom \"0%\" to \"100%\". When paired with cmd this models the chiller's\nload limit. When paired with sensor this models the chiller's current\nload factor.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^conduit,[^equip],,,"Duct, pipe, or cable to convey a substance or phenomenon",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^pipe,[^conduit],,,"Conduit used to convey a fluid",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Pipe_(fluid_conveyance)`,,,,,,,,,,[{pump motor equip},{valve actuator equip},{flow sensor point},{flow sp point},{pressure sensor point},{pressure sp point},{temp sensor point},{temp sp point},{equip},{point}],[^fluid,^pipeSection,^plantLoop],,,,,,
^duct,[^conduit],,,"Conduit used to convey air for HVAC",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Duct_(flow)`,,,,,,,,,,[{damper actuator equip},{fan motor equip},{coolingCoil equip},{heatingCoil equip},{air co2 concentration sensor point},{air co2 concentration sp point},{air dewPoint sensor point},{air dewPoint sp point},{air enthalpy sensor point},{air enthalpy sp point},{air flow sensor point},{air flow sp point},{air humidity sensor point},{air humidity sp point},{air pressure sensor point},{air pressure sp point},{air temp sensor point},{air temp sp point},{equip},{point}],[^ductDeck,^ductSection],,,,,,
^wire,[^conduit],,,"Cabling used to convey electricity or data",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^pipeFluid,[^choice],^fluid,,"Type of fluid conveyed by piping",^lib:phIoT,[^pipe,^valve-actuator,^pump-motor],,,,,,,,,,,,,,,,,,,,,,,,,,
^pipeSection,[^choice],,,"Equipment section of piping",^lib:phIoT,[^pipe,^valve-actuator,^pump-motor],,,,,,,,,,,,,,,,,,,,,,,,,,
^bypass,[^pipeSection],,,"Pipe used to bypass an equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^circ,[^pipeSection],,,"Pipe used to circulate fluid through an equipment or system",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^entering,[^pipeSection],,,"Pipe conveys fluid into an equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^header,[^pipeSection],,,"Pipe used as central connection or manifold for other piping runs.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^leaving,[^pipeSection],,,"Pipe conveys fluid out of an equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^plantLoop,[^choice],,,"Plant piping loop: primary, secondary, or tertiary",^lib:phIoT,[^pipe],,,,,,,,,,,,,,,,,,,,,,,,,,
^primaryLoop,[^plantLoop],,,"Pipework which circulates closest to the energy source.  In a central\nplant, the primary loop indicates the pipes and equipment within the\ncentral plant.  In context of heat exchangers between the primary\nand secondary loops, this tag indicates the side closest to the plant.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^secondaryLoop,[^plantLoop],,,"Pipework which circulates closest to the building or end use. In a\ncentral plant, the secondary loop indicates the pipes and equipment between\nthe central plant and the building.  In context of heat exchangers between\nthe primary and secondary loops, this tag indicates the side closest to\nthe building.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^tertiaryLoop,[^plantLoop],,,"Pipework which circulates within the building.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ductSection,[^choice],,,"Equipment section of ductwork",^lib:phIoT,[^duct,^damper-actuator,^fan-motor],,,,,,,,,,,,,,,,,,,,,,,,,,
^discharge,[^ductSection],,,"Duct for air leaving an equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^economizer,[^ductSection],,,"Duct to access fresh outside air only for economizing, not ventilation",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^inlet,[^ductSection],,,"Duct with air entering an equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^flue,[^ductSection],,,"Duct for exhausting combustion",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Flue`,,,,,,,,,,,,,,,,,
^exhaust,[^ductSection],,,"Duct used to expel air back outside",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^mixed,[^ductSection],,,"Duct where fresh outside air and return air is mixed together",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^outside,[^ductSection],,,"Duct to access fresh outside air for both ventilation and economizer.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^return,[^ductSection],,,"Duct returning air back to equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ventilation,[^ductSection],,,"Duct to access fresh outside air only for ventilation, not economizing",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ductDeck,[^choice],,,"Cold, hot, or neutral deck. Can be applied to 'ahu' equip if the AHU\nis part of a 'dualDuct' or 'tripleDuct' system but only serves a single\ndeck type.",^lib:phIoT,[^duct,^airHandlingEquip],,,,,,,,,,,,,,,,,,,,,,,,,,
^coldDeck,[^ductDeck],,,"Duct carries air for cooling",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hotDeck,[^ductDeck],,,"Duct carries air for heating",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^neutralDeck,[^ductDeck],,,"Duct carries air which by-passes both heating and cooling coils",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ductConfig,[^choice],,,"Ductwork configuration",^lib:phIoT,[^airHandlingEquip,^airTerminalUnit],,,,,,,,,,,,,,,,,,,,,,,,,,
^singleDuct,[^ductConfig],,,"One single duct",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dualDuct,[^ductConfig],,,"Two ducts: combination of hotDeck, coldDeck, or neutralDeck",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^tripleDuct,[^ductConfig],,,"Three ducts: hotDeck, coldDeck, or neutralDeck",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^coolingTower,[^equip,^elec-input],,,"Equipment to transfer waste heat into the atmosphere",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Cooling_tower`,,,,,,,,,,[{condenser water entering pipe equip},{condenser water leaving pipe equip},{fan motor equip},{equip},{point}],,,,,,,
^condenserLoop,[^choice],,,"Open or closed loop for condenser working fluid",^lib:phIoT,[^chilled-water-plant],,,,,,,,,,,,,,,,,,,,,,,,,,
^condenserOpenLoop,[^condenserLoop],,,"Uses working fluid itself for evaporation into the atmosphere",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^condenserClosedLoop,[^condenserLoop],,,"Working fluid is kept separate from fluid used for heat transfer into the atmosphere",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ac,[^marker],,,"Relating to alternating current electricity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dc,[^marker],,,"Relating to direct current electricity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ac-elec,[^elec],,,"Alternating current electricity",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Alternating_current`,,,,,,,,,,,,,,,,,
^dc-elec,[^elec],,,"Direct current electricity",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Direct_current`,,,,,,,,,,,,,,,,,
^phase,[^str],,,"Phase measurement in a three-phase electrical system.  Phase is\ndeprecated in favor of more explicit tags:\n- `lineVolt`\n- `phaseVolt`\n- `lineCurrent`\n- `phaseCurrent`\n- `linePower`\n- `phasePower`\n- `linePf`\n- `phasePf`\n- `lineEnergy`\n- `phaseEnergy`\n- `lineAvg`\n- `phaseAvg`\n- `neutral`\n- `ground`",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Three-phase_electric_power`,,"- A: line-to-neutral measurement\n- B: line-to-neutral measurement\n- C: line-to-neutral measurement\n- AB: line-to-line measurement\n- BC: line-to-line measurement\n- CA: line-to-line measurement\n- N: neutral current",,,,,,,,,,,,,,,
^elecLine,[^str],,,"Single-phase line measurement of an electric quantity in an AC electric\npower system.",^lib:phIoT,,,,,,,,,,,,"- L1: line 1 measurement\n- L2: line 2 measurement\n- L3: line 3 measurement",,,,,,,,,,,,,,,
^elecLineToLine,[^str],,,"Single-phase electric quantity measured line-to-line in an AC electric\npower system.",^lib:phIoT,,,,,,,,,,,,"- L1-L2: line 1 to line 2 measurement\n- L2-L3: line 2 to line 3 measurement\n- L3-L1: line 3 to line 1 measurement",,,,,,,,,,,,,,,
^elecLineToNeutral,[^str],,,"Single-phase electric quantity measured line-to-neutral in an AC\nelectric power system.",^lib:phIoT,,,,,,,,,,,,"- L1-N: line 1 to neutral measurement\n- L2-N: line 2 to neutral measurement\n- L3-N: line 3 to neutral measurement",,,,,,,,,,,,,,,
^lineVolt,[^elecLineToLine],,,"Single-phase voltage measured line-to-line in an AC electric power\nsystem.  May also be referred to as a line voltage measurement.",^lib:phIoT,,,,,,,,,,,,"- L1-L2: line 1 to line 2 measurement\n- L2-L3: line 2 to line 3 measurement\n- L3-L1: line 3 to line 1 measurement",,,,,,,,,,,,,,,
^phaseVolt,[^elecLineToNeutral],,,"Single-phase voltage measured line-to-neutral in an AC electric power\nsystem.  May also be referred to as a phase voltage measurement.",^lib:phIoT,,,,,,,,,,,,"- L1-N: line 1 to neutral measurement\n- L2-N: line 2 to neutral measurement\n- L3-N: line 3 to neutral measurement",,,,,,,,,,,,,,,
^lineCurrent,[^elecLine],,,"Single-phase line current measured in an AC electric power system.",^lib:phIoT,,,,,,,,,,,,"- L1: line 1 measurement\n- L2: line 2 measurement\n- L3: line 3 measurement",,,,,,,,,,,,,,,
^phaseCurrent,[^elecLineToLine],,,"Single-phase current measured line-to-line in an AC electric power\nsystem.  May also be referred to as a phase current measurement.",^lib:phIoT,,,,,,,,,,,,"- L1-L2: line 1 to line 2 measurement\n- L2-L3: line 2 to line 3 measurement\n- L3-L1: line 3 to line 1 measurement",,,,,,,,,,,,,,,
^linePower,[^elecLineToLine],,,"Single-phase power measured line-to-line in an AC electric power system.\nMay also be referred to as a line power measurement.",^lib:phIoT,,,,,,,,,,,,"- L1-L2: line 1 to line 2 measurement\n- L2-L3: line 2 to line 3 measurement\n- L3-L1: line 3 to line 1 measurement",,,,,,,,,,,,,,,
^phasePower,[^elecLine],,,"Single-phase power measured line-to-neutral in an AC electric power\nsystem.  May also be referred to as a phase power measurement.",^lib:phIoT,,,,,,,,,,,,"- L1: line 1 measurement\n- L2: line 2 measurement\n- L3: line 3 measurement",,,,,,,,,,,,,,,
^linePf,[^elecLineToLine],,,"Single-phase power factor measured line-to-line in an AC electric power\nsystem.",^lib:phIoT,,,,,,,,,,,,"- L1-L2: line 1 to line 2 measurement\n- L2-L3: line 2 to line 3 measurement\n- L3-L1: line 3 to line 1 measurement",,,,,,,,,,,,,,,
^phasePf,[^elecLine],,,"Single-phase power factor measured line-to-neutral in an AC electric\npower system.  Neutral might not be referenced, but implied.",^lib:phIoT,,,,,,,,,,,,"- L1: line 1 measurement\n- L2: line 2 measurement\n- L3: line 3 measurement",,,,,,,,,,,,,,,
^lineEnergy,[^elecLineToLine],,,"Single-phase energy measured line-to-line in an AC electric power\nsystem.",^lib:phIoT,,,,,,,,,,,,"- L1-L2: line 1 to line 2 measurement\n- L2-L3: line 2 to line 3 measurement\n- L3-L1: line 3 to line 1 measurement",,,,,,,,,,,,,,,
^phaseEnergy,[^elecLine],,,"Single-phase energy measured line-to-neutral in an AC electric power\nsystem.  Neutral might not be referenced, but implied.",^lib:phIoT,,,,,,,,,,,,"- L1: line 1 measurement\n- L2: line 2 measurement\n- L3: line 3 measurement",,,,,,,,,,,,,,,
^lineAvg,[^marker],,,"Line average of single-phase electrical quantity measurements in an AC\nelectric power system.\nWhen applied to a point entity that has the `elec` and `volt` tags,\nindicates the average of all measurements defined in `lineVolt`.\nWhen applied to a point entity that has the `elec` and `current` tags,\nindicates the average of all measurements defined in `lineCurrent`.\nWhen applied to a point entity that has the `elec` and `power` tags,\nindicates the average of all measurements defined in `linePower`.\nWhen applied to a point entity that has the `elec` and `pf` tags,\nindicates the average of all measurements defined in `linePf`.\nWhen applied to a point entity that has the `elec` and `energy` tags,\nindicates the average of all measurements defined in `lineEnergy`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^phaseAvg,[^marker],,,"Phase average of single-phase electrical quantity measurements in an AC\nelectric power system.\nWhen applied to a point entity that has the `elec` and `volt` tags,\nindicates the average of all measurements defined in `phaseVolt`.\nWhen applied to a point entity that has the `elec` and `current` tags,\nindicates the average of all measurements defined in `phaseCurrent`.\nWhen applied to a point entity that has the `elec` and `power` tags,\nindicates the average of all measurements defined in `phasePower`.\nWhen applied to a point entity that has the `elec` and `pf` tags,\nindicates the average of all measurements defined in `phasePf`.\nWhen applied to a point entity that has the `elec` and `energy` tags,\nindicates the average of all measurements defined in `phaseEnergy`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^neutral,[^marker],,,"Used to indicate electrical current being measured on an electrical\nneutral conductor when applied to a point entity that has the `elec` and\n`current` tags.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^phaseCount,[^choice],,,"Number of phases for an AC electrical power system or\nconnected equipment: single-phase or three-phase.",^lib:phIoT,[^ac-elec-meter,^motor],,,,,,,,,,,,,,,,,,,,,,,,,,
^singlePhase,[^phaseCount],,,"Single-phase AC electrical power. Power is provided by a\nsingle AC voltage source.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^threePhase,[^phaseCount],,,"Three-phase AC electrical power. Power is provided by three AC voltage\nsources, each separated from the others by a 120-degree phase angle.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ac-freq,[^freq],,,"Frequency of alternating current",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["Hz"],,,,,,,,,
^pf,[^quantity],,,"Electric power factor; which is the ratio of active power to apparent\npower in an AC electric power system.  Measured with numbers in the range\nof -1.0 to 1.0 or 0.0 to 1.0 with a special unit called 'pf', which is\neffectively unitless and used for data visualization.",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["pf"],,,,,,,,,
^pfScope,[^choice],,,"Power factor scope",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^pfTrue,[^pfScope],,,"True power factor, which includes effects of harmonic distortion.\nPower factor is assumed to be true power factor when `pfScope` is not\ndefined.  However, it is recommended to specify a scope for power\nfactor to help avoid misinterpretation of data.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^pfDisplacement,[^pfScope],,,"Displacement power factor, which excludes effects of harmonic\ndistortion.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^pfDistortion,[^pfScope],,,"Distortion power factor",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^active-power,[^elec-power],,,"Active power or real power; energy transfer that contributes useful work",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["kW"],,,,,,,,,
^reactive-power,[^quantity],,,"Reactive power or imaginary power; energy transfer that contributes useful work",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["kVAR"],,,,,,,,,
^apparent-power,[^quantity],,,"Apparent power is perceived magnitude of power due to the combination of active and reactive power",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["kVA"],,,,,,,,,
^elec-demand,[^active-power],,,"Active power averaged over a rolling interval.  For utility meters\nthe demand interval is based on the billing period.",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["kW"],,,,,,,,,
^active-energy,[^elec-energy],,,"Integral of `active-power` over time",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["kWh"],,,,,,,,,
^reactive-energy,[^quantity],,,"Integral of `reactive-power` over time",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],,,,,,,,,,
^apparent-energy,[^quantity],,,"Integral of `apparent-power` over time",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],,,,,,,,,,
^current-magnitude,[^elec-current],,,"Magnitude of electrical current",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["A"],,,,,,,,,
^current-angle,[^quantity],,,"AC current phase angle",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["deg"],,,,,,,,,
^current-imbalance,[^quantity],,,"AC current imbalance",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["%"],,,,,,,,,
^current-thd,[^quantity],,,"Total harmonic distortion (THD) of current",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["%"],,,,,,,,,
^volt-magnitude,[^elec-volt],,,"Magnitude of electrical voltage",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["A"],,,,,,,,,
^volt-angle,[^quantity],,,"AC voltage phase angle",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["deg"],,,,,,,,,
^volt-imbalance,[^quantity],,,"AC voltage imbalance",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["%"],,,,,,,,,
^volt-thd,[^quantity],,,"Total harmonic distortion (THD) of voltage",^lib:phIoT,,,,,,,,,,,,,,,,,[^ac-elec],["%"],,,,,,,,,
^stateOfCharge,[^quantity],,,"State of charge (SoC) of an electric `battery`.  Uses a percentage in\nthe range of 0% to 100%, where no charge is indicated as 0% and full\ncharge is indicated as 100%.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/State_of_charge`,,,,,,,[^dc-elec],["%"],,,,,,,,,
^equip,[^entity],,M,"Equipment asset.\nSee `docHaystack::Equips` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,M,,,,,
^equipRef,[^ref],^equip,,"Reference to equip which contains this entity",^lib:phIoT,[^equip,^point,^controller],,,,,,,,,,,,,,,,,,,,,,^equip,,,,
^evse,[^marker],,,"Electric Vehicle Supply Equipment.  See `docHaystack::EVSE` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,,,,,,,,
^evse-system,[^elec-system],,,"A system that supplies electricity to EVSE assembly equipment and its\nauxiliary loads.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^evse-equip,[^equip,^elec-input,^elec-output],,,"Equipment that supports the delivery of electricity to charging inlets\nlocated on EVs.  See `docHaystack::EVSE` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{equip},{point}],,,,,,,
^evse-powerConverter,[^evse-equip],,,"A power converter that has a `dc` electrical output applied to a\n`dc-evse-port`.  May be contained within an `evse-dispenser` or in a\nseparate dedicated equipment enclosure.\nChildren points are used to describe or control one or more `evse-port`\nwithin the EVSE manufacturer's package.\nSee `docHaystack::EVSE#powerConverter` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{evse port equip},{evse evseStatus sensor point},{import dc elec power max sp point},{equip},{point}],,,,,,,
^evse-dispenser,[^evse-equip],,,"Equipment that dispenses electricity to an EV.  It consists of a\nphysical EVSE enclosure and its contents to which an `evse-cable`\nattaches.  An `evse-dispenser` can contain zero or more `evse-port`.\nChildren points are used to describe or control one or more `evse-port`\nwithin the EVSE manufacturer's package.\nSee `docHaystack::EVSE#dispenser` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{evse port equip},{evse evseStatus sensor point},{import ac elec magnitude current max sp point},{import dc elec power max sp point},{equip},{point}],,,,,,,
^evse-port,[^evse-equip,^elec-meter],,,"An EVSE port delivers electricity to a single EV charging inlet at a\ntime.  Comprised of a software-controlled electrical contactor or\ncircuit breaker.  Typically contained within an `evse-dispenser`, but\nmay be contained within an `evse-powerConverter`.  More than one\n`evse-cable` may be connected to a single `evse-port`, however, only one\nmay be energized at any given time.\nNote:  In the future we might add an entity that describes `evse-port`\ncontained in an AC distribution panel.  This scenario is not common.\nSee `docHaystack::EVSE#port` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{evse cable equip},{evse evseStatus sensor point},{equip},{point}],,,,,,,
^ac-evse-port,[^evse-port],,,"An AC EVSE port delivers `ac` electricity to a single EV charging inlet\nat a time.  See `docHaystack::EVSE#port` chapter.\nTypically a max current or max power setpoint should reference an AC\nEVSE port, but not both.  Usually it is preferred to control an AC EVSE\nport using a max current setpoint.\nIt is recommended to include electrical location related tags on\nelectrical points that reference an AC EVSE port.  See\n`docHaystack::Meters#elecMeters` chapter for more details.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{import ac elec magnitude current sensor point},{import ac elec magnitude volt sensor point},{import ac elec active power sensor point},{import ac elec pfScope pf sensor point},{import ac elec active energy hisTotalized sensor point},{dc elec stateOfCharge sensor point},{import ac elec magnitude current max sp point},{import ac elec active power max sp point},{evse cable equip},{evse evseStatus sensor point},{equip},{point}],,,,,,,
^dc-evse-port,[^evse-port],,,"A DC EVSE port delivers `dc` electricity to a single EV charging inlet\nat a time.  See `docHaystack::EVSE#port` chapter.\nTypically a max current or max power setpoint should reference a DC\nEVSE port, but not both.  Usually it is preferred to control a DC EVSE\nport using a max power setpoint.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{import dc elec current sensor point},{import dc elec volt sensor point},{import dc elec power sensor point},{import dc elec energy hisTotalized sensor point},{dc elec stateOfCharge sensor point},{import dc elec current max sp point},{import dc elec power max sp point},{evse cable equip},{evse evseStatus sensor point},{equip},{point}],,,,,,,
^evse-cable,[^evse-equip],,,"The electrical cable between an `evse-port` and an EV charging inlet\non a vehicle. The `evseCableType` tag distinguishes the type of cable.\nSee `docHaystack::EVSE#cable` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Charging_station`,,,,,,,,,,[{equip},{point}],,,,,,,
^evseSession,[^entity],,,"Describes an event during which an `evse-port` can deliver power to an EV.\nThe EVSE may need to authorize a user to initiate an `evseSession`.\nAt minimum has the following data:\n- ts:  when the event was logged by the system of record\n- started:  when the event started\n- stopped:  when the event stopped\n- tx:  transaction ID for the event\n- targetRef:  reference to the `evse-port`\n- energyDelivered:  energy delivered during the `evseSession`\n- event:  marker tag\n- meterStart:  meter register's value at the beginning of the `evseSession`\nIn the future additional data might be included, such as the means of\nEV charging session authorization.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,M,,,,,
^evseStatus,[^str],,,"Status of one or more `evse-port` reported by an EVSE.\nWhen applied to an `evse-port`, indicates the status of an EVSE port.\nWhen applied to an `evse-dispenser` or `evse-powerConverter`, indicates\nthe status of one or more `evse-port` within an EVSE manufacturer's\npackage.  In this case only the enum values available, unavailable,\nand fault apply.",^lib:phIoT,,,,,,,,,,,,"- available:  When the point references an `evse-port`, indicates the\n`evse-port` is available for recharging a vehicle.  During this\ncondition none of the `evse-cable` that reference the `evse-port` are\nplugged into a vehicle charging inlet.  Also, a parked vehicle may\nprohibit another vehicle from recharging.\nWhen the point references `evse-dispenser` or `evse-powerConverter`,\nindicates `evse-port` within the EVSE manufacturer's package are\navailable for an `evseSession` and may actively be in one.  Also, an\n`evse-port` may have another `evseStatus` based on its condition.\n- preparing:  After an `evse-port` is no longer available and before an\n`evseSession` begins.  Typically this condition applies during the\nauthorization of an `evseSession`.  This value is deprecated in favor\nof the occupied value.\n- charging:  When there is an active `evseSession` and the contactor\nfor the `evse-port` is closed.  This value is deprecated in favor of\nthe occupied value.\n- suspendedEVSE:  When the `evse-port` is occupied and not within an\nactive `evseSession` due to inavailability of power to deliver to the\nvehicle or an unsuccessful attempt to establish an `evseSession`.\nThis value is deprecated in favor of the occupied value.\n- suspendedEV:  When a vehicle does not accept power being offered by\nthe `evse-port` during an active `evseSession`.  This value is\ndeprecated in favor of the occupied value.\n- finishing:  After an `evseSession` when the `evse-port` is still\noccupied.  This value is deprecated in favor of the occupied value.\n- occupied:  When an `evse-cable` that references the `evse-port` is\nplugged into a vehicle's charging inlet.  During this condition the\n`evse-port` may or may not be within an active `evseSession`.\n- reserved:  When the `evse-port` is dedicated to a specific user.\nDuring this condition only the intended user can authorize an\n`evseSession` with their vehicle.  An unauthorized user and their\nparked vehicle may prohibit an authorized user from recharging.\n- unavailable:  When the EVSE prohibits EV charging on the `evse-port`\ndue to an applied software setting for the `evse-port` or EVSE\nmanufacturer's package.\n- fault:  When the EVSE prohibits EV charging on the `evse-port` due to\na fault condition within the `evse-port` or EVSE manufacturer's\npackage.",,,,,,,,,,,,,,,
^evseCableType,[^str],,,"Physical type of `evse-cable`.",^lib:phIoT,[^evse-cable],,,,,,,,,,,"- ccs1:  CCS1 charging cable\n- ccs2:  CCS2 charging cable\n- chademo:  CHAdeMO charging cable\n- saeJ3400:  SAE J3400 charging cable\n- saeJ1772:  SAE J1772 charging cable\n- saeJ3068:  SAE J3068 charging cable\n- iecType2:  IEC 62196 Type 2 charging cable\n- mcs:  Megawatt Charging System charging cable\n- gbt:  GB/T charging cable",,,,,,,,,,,,,,,
^fumeHood,[^equip,^elec-input],,,"Ventilation equipment to limit exposure to hazardous fumes.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fume_hood`,,,,,,,,,,[{alarm sensor point},{air flow sensor point},{air flow sp point},{air velocity sensor point},{air velocity sp point},{equip},{point}],,,,,,,
^airRef,[^ref],^air-output,,"Air flows from the referent to this entity",^lib:phIoT,[^air-input],,,,,,,,,,,,,,,,,,,,,,,^air,,,
^blowdownWaterRef,[^ref],^blowdown-water-output,,"Blowdown water flows from the referent to this entity",^lib:phIoT,[^blowdown-water-input],,,,,,,,,,,,,,,,,,,,,,,^blowdown-water,,,
^condensateRef,[^ref],^condensate-output,,"Condensate flows from the referent to this entity",^lib:phIoT,[^condensate-input],,,,,,,,,,,,,,,,,,,,,,,^condensate,,,
^chilledWaterRef,[^ref],^chilled-water-output,,"Chilled water flows from the referent to this entity",^lib:phIoT,[^chilled-water-input],,,,,,,,,,,,,,,,,,,,,,,^chilled-water,,,
^condenserWaterRef,[^ref],^condenser-water-output,,"Condenser water flows from the referent to this entity",^lib:phIoT,[^condenser-water-input],,,,,,,,,,,,,,,,,,,,,,,^condenser-water,,,
^domesticWaterRef,[^ref],^domestic-water-output,,"Domestic water flows from the referent to this entity",^lib:phIoT,[^domestic-water-input],,,,,,,,,,,,,,,,,,,,,,,^domestic-water,,,
^elecRef,[^ref],^elec-output,,"Electricity flows from the referent to this entity",^lib:phIoT,[^elec-input],,,,,,,,,,,,,,,,,,,,,,,^elec,,,
^fuelOilRef,[^ref],^fuelOil-output,,"Fuel oil flows from the referent to this entity",^lib:phIoT,[^fuelOil-input],,,,,,,,,,,,,,,,,,,,,,,^fuelOil,,,
^hotWaterRef,[^ref],^hot-water-output,,"Hot water flows from the referent to this entity",^lib:phIoT,[^hot-water-input],,,,,,,,,,,,,,,,,,,,,,,^hot-water,,,
^gasolineRef,[^ref],^gasoline-output,,"Gasoline flows from the referent to this entity",^lib:phIoT,[^gasoline-input],,,,,,,,,,,,,,,,,,,,,,,^gasoline,,,
^makeupWaterRef,[^ref],^makeup-water-output,,"Makeup water flows from the referent to this entity",^lib:phIoT,[^makeup-water-input],,,,,,,,,,,,,,,,,,,,,,,^makeup-water,,,
^naturalGasRef,[^ref],^naturalGas-output,,"Natural gas flows from the referent to this entity",^lib:phIoT,[^naturalGas-input],,,,,,,,,,,,,,,,,,,,,,,^naturalGas,,,
^refrigRef,[^ref],^refrig-output,,"Refrigerant flows from the referent to this entity",^lib:phIoT,[^refrig-input],,,,,,,,,,,,,,,,,,,,,,,^refrig,,,
^steamRef,[^ref],^steam-output,,"Steam flows from the referent to this entity",^lib:phIoT,[^steam-input],,,,,,,,,,,,,,,,,,,,,,,^steam,,,
^air-output,[^output],,,"Entity outputs air to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^blowdown-water-output,[^output],,,"Entity outputs blowdown water to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^condensate-output,[^output],,,"Entity outputs condensate to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^chilled-water-output,[^output],,,"Entity outputs chilled water to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^condenser-water-output,[^output],,,"Entity outputs condenser water to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^domestic-water-output,[^output],,,"Entity outputs domestic water to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^elec-output,[^output],,,"Entity outputs electricity to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^fuelOil-output,[^output],,,"Entity outputs fuel oil to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hot-water-output,[^output],,,"Entity outputs hot water to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^gasoline-output,[^output],,,"Entity outputs gasoline to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^makeup-water-output,[^output],,,"Entity outputs makeup water to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^naturalGas-output,[^output],,,"Entity outputs natural gas to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^refrig-output,[^output],,,"Entity outputs refrigerant to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^steam-output,[^output],,,"Entity outputs steam to other entities",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^air-input,[^input],,,"Entity inputs air which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^blowdown-water-input,[^input],,,"Entity inputs blowdown water which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^condensate-input,[^input],,,"Entity inputs condensate which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^chilled-water-input,[^input],,,"Entity inputs chilled water which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^condenser-water-input,[^input],,,"Entity inputs condenser water which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^domestic-water-input,[^input],,,"Entity inputs domestic water which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^elec-input,[^input],,,"Entity inputs electricity which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^fuelOil-input,[^input],,,"Entity inputs fuel oil which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hot-water-input,[^input],,,"Entity inputs hot water which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^gasoline-input,[^input],,,"Entity inputs gasoline which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^makeup-water-input,[^input],,,"Entity inputs makeup water which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^naturalGas-input,[^input],,,"Entity inputs natural gas which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^refrig-input,[^input],,,"Entity inputs refrigerant which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^steam-input,[^input],,,"Entity inputs steam which flows from another entity",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^heatExchanger,[^equip],,,"Equipment to transfer heat between two working fluids.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Heat_exchanger`,,,,,,,,,,[{equip},{point}],,,,,,,
^coil,[^heatExchanger],,,"Heat exchanger used to heat or cool air.  Coils are sub-components\nof HVAC equipment such as `airHandlingEquip`.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils`,,,,,,,,,,[{equip},{point}],,,,,,,
^coolingCoil,[^coil],,,"Coil used to cool air.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils`,,,,,,,,,,[{stage:1 cool run cmd point},{chilled water cool valve cmd point},{equip},{point}],[^ductDeck,^ductSection],,,,,,
^heatingCoil,[^coil],,,"Coil used to heat air.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Heat_exchanger#HVAC_air_coils`,,,,,,,,,,[{stage:1 heat run cmd point},{hot water heat valve cmd point},{steam heat valve cmd point},{equip},{point}],[^ductDeck,^ductSection],,,,,,
^lib:phIoT,[^lib],,,"Project Haystack definitions for Internet of Things",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Internet_of_things`,,,"3.9.15",`https://project-haystack.org/def/phIoT/`,,,,,[^lib:ph,^lib:phScience],,,,,,,,
^luminaire,[^equip,^lightingZonePoints,^elec-input],,,"Light fixture using electricity to provide illumination",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Light_fixture`,,,,,,,,,,[{equip},{point},{light level sensor point},{light level sp point},{light illuminance sensor point},{light luminous flux sensor point}],,,,,,,
^meter,[^equip],,,"Equipment to meter a substance or phenomenon.\nSee `docHaystack::Meters` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^elec-meter,[^meter,^elec-input,^elec-output],,,"Electricity meter",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^ac-elec-meter,[^elec-meter],,,"AC Electricity meter.\nSee `docHaystack::Meters` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{total net ac elec active energy sensor point},{total import ac elec active energy sensor point},{total export ac elec active energy sensor point},{phase:"A" net ac elec active energy sensor point},{total ac elec demand sensor point},{total active ac elec power sensor point},{total reactive ac elec power sensor point},{total apparent ac elec power sensor point},{phase:"A" active ac elec power sensor point},{phase:"A" reactive ac elec power sensor point},{phase:"A" apparent ac elec power sensor point},{avg ac elec current magnitude sensor point},{avg ac elec current angle sensor point},{avg ac elec current imbalance sensor point},{avg ac elec current thd sensor point},{phase:"A" ac elec current magnitude sensor point},{phase:"A" ac elec current angle sensor point},{phase:"A" ac elec current imbalance sensor point},{phase:"A" ac elec current thd sensor point},{avg ac elec volt magnitude sensor point},{avg ac elec volt angle sensor point},{avg ac elec volt imbalance sensor point},{avg ac elec volt thd sensor point},{phase:"A" ac elec volt magnitude sensor point},{phase:"A" ac elec volt angle sensor point},{phase:"A" ac elec volt imbalance sensor point},{phase:"A" ac elec volt thd sensor point},{avg ac elec pf sensor point},{phase:"A" ac elec pf sensor point},{equip},{point}],,,,,,,
^dc-elec-meter,[^elec-meter],,,"DC Electricity meter.\nSee `docHaystack::Meters` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^flow-meter,[^meter],,,"Meter to measure flow rate and total volume of fluid.\nSee `docHaystack::Meters` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^meterScope,[^choice],,,"Classifies a meter as a main site meter or submeter",^lib:phIoT,[^meter],,,,,,,,,,,,,,,,,,,,,,,,,,
^siteMeter,[^meterScope],,,"Main meter for the associated site",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^submeter,[^meterScope],,,"Submeters measure usage of a sub-system or equipment within a site",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^submeterOf,[^ref],^meter,,"Reference to parent meter which is immediately upstream of this meter",^lib:phIoT,[^meter],,,,,,,,,,,,,,,,,,,,,,,,,,
^absorption,[^marker],,,"Cooling process using energy from heat source such as hot water",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Absorption_refrigerator`,,,,,,,,,,,,,,,,,
^active,[^marker],,,"Working, operative, effective",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^alarm,[^marker],,,"Notification of a condition which requires attention",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^barometric,[^marker],,,"Relating atmospheric pressure",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^blowdown,[^marker],,,"Removal from container or pipe",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^cable,[^equip],,,"An assembly of one or more insulated conductors.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^centrifugal,[^marker],,,"Compression via a continuous flow of fluid through an impeller",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Centrifugal_compressor`,,,,,,,,,,,,,,,,,
^cold,[^marker],,,"Having low degree of heat",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^compressor,[^marker],,,"Device for mechanically increasing the pressure of a gas or refrigerant\nvapor by reducing its volume.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^condenser,[^marker],,,"Device or related to process of condensation",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^conditioning,[^marker],,,"Related to cleaning, heating, cooling, humidifying, dehumidifying,\nventilating or circulating \u00a0air.\u00a0",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^controls,[^marker],,,"Associated with the control system for an industrial process",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Control_system`,,,,,,,,,,,,,,,,,
^cool,[^marker],,,"Associted with low temperature or cooling processes.  When used on a point,\nthis tag is associated with the control of cooling.  When paired with a\nsubstance, this tag indicates the substance is relatively cool in comparison\nto another substance, without being actively cooled by e.g. a chiller.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^coolingOnly,[^marker],,,"Equipment without heating",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^chilled,[^marker],,,"Substance is cooled using cooling process",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^cur,[^marker],,,"Supports current value",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^deadband,[^marker],,,"The range in a process where no changes to output are made.\nMay also indicate the difference between a base setpoint and effective\nsetpoint.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^delta,[^marker],,,"Differential of fluid between entering and leaving sensors.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^demand,[^marker],,,"Rate required for a process.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^design,[^marker],,,"Data related to intended design and operating conditions.  This\nincludes sizing and other data specified by design engineers and\nengineered drawings.  Also see `rated`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dessicantDehumidifier,[^marker],,,"Decreases humidity from air using a substance which absorbs moisture.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dispenser,[^marker],,,"Equipment that releases a specific amount of a substance.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^diverting,[^marker],,,"Three way valve which inputs one pipe and diverts between two output pipes.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^domestic,[^marker],,,"For human use",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^economizing,[^marker],,,"Energy reduction mode which augments heating/cooling with outside air.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^effective,[^marker],,,"Current control setpoint in effect taking into account other factors",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^enable,[^marker],,,"Secondary on/off `point` of an `equip` especially used with a `vfd`.\nEnable is used with Bool points where true indicates on and false\nindicates off.  Equip with an enable should always also define a `run`\npoint which indicates the primary on/off state of the equipment.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^evaporator,[^marker],,,"Mechanism used to convert a refrigerant from its liquid to gaseous state.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^extraction,[^marker],,,"Taking a substance out of another substance",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^export,[^marker],,,"Supplied out of a system",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^faceBypass,[^marker],,,"Point of an ahu indicating air flow is by-passing the heating/cooling\ncoils. If a boolean point, then true indicates the unit is in by-pass\nmode and false indicates by-pass is disabled. If the point is an analog\npoint then 100% indicates full by-pass mode and 0% indicates by-pass is\ncompletely disabled.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^fanPowered,[^marker],,,"Device with a fan",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^filter,[^marker],,,"Related to an air or fluid filter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^freezeStat,[^marker],,,"A boolean point of an ahu indicating a freezing condition.  This\nmight require a control sequence to protect the equipment. If true\nthen a freeze condition is detected, or false if not.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ground,[^marker],,,"Related to the surface of the earth.  Used to indicate electrical\ncurrent being measured on an electrical ground conductor when applied to\na point entity that has the `elec` and `current` tags.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^heat,[^marker],,,"Associated with a heating process.  When used on a point,\nthis tag is associated with the control of heating.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^heatingOnly,[^marker],,,"Equipment without cooling",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^heatPump,[^marker],,,"Equipment that employs a vapor compression cycle with a reversing\nvalve to provide heating or cooling. For vapor compression heating\nwithout a reversing valve, such as for a heat pump water heater,\nsee `dxHeating` which should be used.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Heat_pump`,,,,,,,,,,,,,,,,,
^heatWheel,[^marker],,,"Boolean point indicating command state of AHU's heat wheel.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Thermal_wheel`,,,,,,,,,,,,,,,,,
^his,[^marker],,,"Supports historization of data",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^hot,[^marker],,,"Having high degree of heat",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hvac,[^marker],,,"Heating, ventilation, and air conditioning",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/HVAC`,,,,,,,,,,,,,,,,,
^humidifier,[^marker],,,"Adding moisture to air",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^imbalance,[^marker],,,"Lacking balance",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^import,[^marker],,,"Received into a system",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^infiltration,[^marker],,,"Permeation of a substance into another substance",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^isolation,[^marker],,,"Actuator used to isolate an equipment from a pipe or ductwork system",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^lighting,[^marker],,,"Systems associated with illumination in the built environment",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Lighting`,,,,,,,,,,,,,,,,,
^occupancy,[^marker],,,"Number of occupants in a space.\nSee `docHaystack::Zones#occupancy` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^occupants,[^marker],,,"People who use the built environment.\nSee `docHaystack::Zones#occupancy` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^occupied,[^marker],,,"Setpoint or sensor indicating occupancy of a space.\nSee `docHaystack::Zones#occupancy` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^makeup,[^marker],,,"Restore something missed or lost",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^mech,[^marker],,,"Associated with a machine or its mechanical force, torque, power, or energy.\nThis is often opposed to `elec` electrical energy.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^mixing,[^marker],,,"Three way valve which inputs two pipes and outputs a mixture\nbetween the two to a single output pipe.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^net,[^marker],,,"Difference between import and export",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^occ,[^marker],,,"Occupied mode of a space.\nSee `docHaystack::Zones#occupancy` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^parallel,[^marker],,,"Circuit with multiple paths of flow",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^port,[^marker],,,"A gateway or opening used to transfer a substance.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^powerConverter,[^marker],,,"Converts one electrical waveform to another using power electronic\ncircuitry.  Involves the use of one or more power modules.\nMay convert:\n- `ac` to `dc`\n- `ac` to `ac`\n- `dc` to `dc`\n- `dc` to `ac`\nNote:  An AC/AC power converter performs the same task as a power\ntransformer but using power electronics.  Similarly, a DC/DC power\nconverter transforms an input DC voltage to an output DC voltage at\nanother level.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^purge,[^marker],,,"Associated with a cleaning process to remove contaminants.\nMost commonly it indicates purging water or air by using a filter or by\nletting out a certain amount of the substance at a high flow rate.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^rated,[^marker],,,"Data specified by a manufacturer or rating organization.  Typically this\ninformation is from the equipment data plate or cut sheet.  Also see `design`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^reactive,[^marker],,,"Relating to reactance",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^reheat,[^marker],,,"Command point for reheating process",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^reciprocal,[^marker],,,"Piston compressor driven by a crankshaft",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Reciprocating_compressor`,,,,,,,,,,,,,,,,,
^roof,[^marker],,,"Envelope covering the top of a building",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^rotaryScrew,[^marker],,,"Rotary screw compression",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Rotary-screw_compressor`,,,,,,,,,,,,,,,,,
^run,[^marker],,,"Primary on/off `point` of an `equip` especially used with a `vfd`.\nRun is used with Bool points where true indicates on and false indicates\noff. When paired with `cmd` this is the commanded state of the equipment.\nWhen paired with `sensor` this is the actual status of the equip.  If\nthe equipment also defines an `enable` point then both must be commanded\non in order to run the equipment.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^series,[^marker],,,"Circuit with single path of flow",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^serviceFactor,[^marker],,,"Ratio of the maximum continuous output capacity at which a machine or\nsystem may operate without damage to the machine or system\u2019s nominal\noutput capacity.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^stage,[^int],,,"Stage number of staged equipment operation such as coil or pump.\nThe first stage is 1, second stage 2, etc.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,1,,
^standby,[^marker],,,"Readiness mode of a space",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^switch,[^marker],,,"Device for toggling state or routing data",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^subterranean,[^marker],,,"Below the surface of the earth",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^thermal,[^marker],,,"Related to energy of heat",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^thd,[^marker],,,"Total harmonic distortion",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^unocc,[^marker],,,"Unoccupied mode of a space.\nSee `docHaystack::Zones#occupancy` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^warm,[^marker],,,"Relatively warm in comparison to another substance, without being\nactively heated. The substance can be used as a source of energy for\na heating process, for example a warm water well in an `ates` system.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^writable,[^marker],,,"Supports writing data",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^zone,[^marker],,,"Related to spaces from a system perspective",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^motor,[^equip,^elec-input],,,"Equipment that converts electrical energy into mechanical energy.\nSee `docHaystack::Motors` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Electric_motor`,,,,,,,,,,[{run cmd point},{enable cmd point},{run sensor point},{enable sensor point},{alarm sensor point},{vfd speed cmd point},{vfd freq cmd point},{vfd speed sensor point},{vfd freq sensor point},{equip},{point}],,,,,,,
^vfd,[^marker],,,"Variable-frequency drive.\nSee `docHaystack::Motors` chapter.",^lib:phIoT,[^motor],,,,,,,,,`https://en.wikipedia.org/wiki/Variable-frequency_drive`,,,,,,,,,,,,,,,,,
^vfd-speed,[^quantity],,,"VFD speed measured in \"%\"; 0% is off and 100% is the fastest speed.",^lib:phIoT,,,,,,,,,,,,,,,,,,["%"],,,,,,,,,
^vfd-freq,[^quantity],,,"VFD frequency measured in \"Hz\".",^lib:phIoT,,,,,,,,,,,,,,,,,,["Hz"],,,,,,,,,
^fan,[^marker],,,"Fan equipment or control point",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fan_(machine)`,,,,,,,,,,,,,,,,,
^fan-motor,[^motor],,,"Motor used with a fan to create air flow.\nSee `docHaystack::Motors` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fan_(machine)`,,,,,,,,,,[{run cmd point},{enable cmd point},{run sensor point},{enable sensor point},{alarm sensor point},{vfd speed cmd point},{vfd freq cmd point},{vfd speed sensor point},{vfd freq sensor point},{equip},{point}],[^ductSection,^fan],,,,,,
^pump,[^marker],,,"Pump equipment or control point",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Pump`,,,,,,,,,,,,,,,,,
^pump-motor,[^motor],,,"Motor used with a pump to move fluid.\nSee `docHaystack::Motors` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Pump`,,,,,,,,,,[{run cmd point},{enable cmd point},{run sensor point},{enable sensor point},{alarm sensor point},{vfd speed cmd point},{vfd freq cmd point},{vfd speed sensor point},{vfd freq sensor point},{equip},{point}],[^fluid,^pipeSection,^pump],,,,,,
^op:hisRead,[^op],,,"Read historized time series data from a `his-point`.\nSee `docHaystack::Ops#hisRead` chapter.",^lib:phIoT,,,,,,,,,,,,,,,M,,,,,,,,,,,,
^op:hisWrite,[^op],,,"Write historized time series data from a `his-point`.\nSee `docHaystack::Ops#hisWrite` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^op:pointWrite,[^op],,,"Read or command a `writable-point`.\nSee `docHaystack::Ops#pointWrite` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^op:invokeAction,[^op],,,"Invoke a user action on a target entity.\nSee `docHaystack::Ops#invokeAction` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^panel,[^equip],,,"Enclosure for electrical and control equipment.  Panels may be\nused to isolate electrical connections and provide environmental\nprotection.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^elec-panel,[^panel,^elec-input,^elec-output],,,"Physical housing for electrical circuits, fuses, and breakers.\nSee `docHaystack::ElecPanels#panels` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Distribution_board`,,,,,,,,,,[{equip},{point}],,,,,,,
^circuit,[^equip,^elec-input,^elec-output],,,"Electrical circuit and its associated components such as breakers.\nSee `docHaystack::ElecPanels#circuits` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Electrical_network`,,,,,,,,,,[{equip},{point}],,,,,,,
^plant,[^equip],,,"Central plant used to generate a substance for a process.\nSee `docHaystack::Plants`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{enable cmd point},{equip},{point}],,,,,,,
^chilled-water-plant,[^plant,^chilled-water-output],,,"Plant used to generate chilled water for cooling.\nSee `docHaystack::Plants`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{chiller equip},{coolingTower equip},{chilled water bypass pipe equip},{chilled water entering pipe equip},{chilled water leaving pipe equip},{chilled water header pipe equip},{chilled water heatExchanger equip},{chilled water delta flow point},{chilled water delta pressure point},{chilled water delta temp point},{chilled water mixing valve cmd point},{condenser water bypass pipe equip},{condenser water delta flow sensor point},{condenser water delta pressure sensor point},{condenser water delta temp sensor point},{enable cmd point},{equip},{point}],,,,,,,
^hot-water-plant,[^plant,^hot-water-output],,,"Plant used to generate hot water for heating.\nSee `docHaystack::Plants`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{hot water boiler equip},{hot water bypass pipe equip},{hot water entering pipe equip},{hot water leaving pipe equip},{hot water header pipe equip},{hot water heatExchanger equip},{hot water delta pressure sensor point},{hot water delta flow sensor point},{hot water delta temp sensor point},{hot water mixing valve cmd point},{makeup water entering pipe equip},{outside duct equip},{flue duct equip},{enable cmd point},{equip},{point}],,,,,,,
^steam-plant,[^plant,^steam-output],,,"Plant used to generate steam for heating.\nSee `docHaystack::Plants`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{steam boiler equip},{steam leaving pipe equip},{condensate entering pipe equip},{steam bypass pipe equip},{steam header pipe equip},{steam heatExchanger equip},{steam delta pressure sensor point},{steam delta flow sensor point},{steam delta temp sensor point},{steam mixing valve cmd point},{makeup water entering pipe equip},{outside duct equip},{flue duct equip},{enable cmd point},{equip},{point}],,,,,,,
^point,[^entity],,M,"Data point such as a sensor or actuator.\nSee `docHaystack::Points` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,M,,,,,
^pointGroup,[^entity],,,"Grouping of children points used by spaces and equipment",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^pointSubject,[^choice],^phenomenon,,"What the point senses or controls",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^pointQuantity,[^choice],^quantity,,"Quantity the point senses or controls",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^pointFunction,[^choice],,,"Classifies the point as a sensor, command, or setpoint.\nSee `docHaystack::Points#function` chapter.",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,,,,,,
^sensor,[^pointFunction],,,"Point is a sensor, input, AI/BI.\nSee `docHaystack::Points#function` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^cmd,[^pointFunction],,,"Point is a command, actuator, AO/BO.\nSee `docHaystack::Points#function` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^sp,[^pointFunction],,,"Point is a setpoint, soft point, internal control variable, schedule.\nSee `docHaystack::Points#function` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^cur-point,[^point],,,"Point with support to report a \"real-time\" current value.  By real-time\nwe typically mean freshness within the order of a few seconds or at\nmost a few minutes.  For systems with direct I/O the current value is\ntypically driven by the I/O scan rate. For overlay systems which acquire\ndata via a protocol such as BACnet or Modbus then the current value\nis typically refreshed using polling or subscription over a network.\nAlso see `docHaystack::Points#cur` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^curVal,[^scalar],,,"Current value of a point.  The current value is only available when\nthe `curStatus` is \"ok\" or \"stale\".",^lib:phIoT,[^cur-point],,,,,,,,,,,,,,,,,,,,,,,,,M,
^curStatus,[^str],,,"Status of point's current value reading.  The `curVal` is only available\nwhen curStatus is \"ok\" or \"stale\".  However a \"stale\" value should\nbe used with caution since the local system does not have a fresh value.\nIt is recommended that the `curVal` tag is removed from a point\nwhen the curStatus is not \"ok\" nor \"stale\".",^lib:phIoT,[^cur-point],,,,,,,,,,,"- ok: all is okay\n- stale: the point's curVal is not fresh data\n- fault: a configuration or hardware problem - see `curErr`\n- down: a communication or network problem - see `curErr`\n- disabled: manual disable of the point or connector\n- unknown: we don't know anything (usually boot state)\n- remoteFault: point in remote system is fault\n- remoteDown: point in remote system is down\n- remoteDisabled: point in remote system is disabled\n- remoteUnknown: point in remote system is unknown",,,,,,,,,,,,,,M,
^curErr,[^str],,,"Error description when `curStatus` indicates error condition",^lib:phIoT,[^cur-point],,,,,,,,,,,,,,,,,,,,,,,,,M,
^his-point,[^point],,,"Historized point with a history log of timestamp/value pairs.  Points\nmarked as historized indicate the system can response to queries via\nthe 'hisRead' operation to return a trend log of timestamp/value pairs.\nThere are typically two mechanisms for historization:\n- the local system performs the historization by logging the\npoint's `curVal` to local storage\n- in overlay systems a downstream device performs the historization\nand the local system synchronizes the history data in batch on\na periodic basis\nAlso see `docHaystack::Points#his` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hisMode,[^str],,,"Indicates the way that history data is collected for a point.",^lib:phIoT,[^his-point],,,,,,,,,,,"- sampled: Data is sampled on a regular interval. The timestamp\nindicates exactly when the sample was taken, and we assume linear\ninterpolation between samples.\n- cov: Data is logged when it changes. The means the timestamp\nindicates exactly when it changed (inclusive) and it remains that\nvalue until the next sample's timestamp (exclusive).\n- consumption: Integral data is sampled on a regular interval and\nlogged at the *end* of the interval. The timestamp indicates the\n*end* of the interval. Therefore, the raw data is logged as\nstart *exclusive*, end *inclusive*.  This is mode is typical for\nconsumption meters.",,,,,,,,,,,,,,,
^hisTotalized,[^marker],,,"Indicates values which are a continuous stream of totalization. History\ndata reads and should be normalized by computing the delta.",^lib:phIoT,[^his-point],,,,,,,,,,,,,,,,,,,,,,,,,,
^hisStatus,[^str],,,"Status of point's history collection or synchronization",^lib:phIoT,[^his-point],,,,,,,,,,,"- ok: last sync attempt was successful\n- fault: a configuration problem - see `hisErr`\n- down: a communication or network problem - see `hisErr`\n- disabled: manual disable of the point or parent connector\n- unknown: we don't know anything (usually boot state)\n- pending: sync has been scheduled and is waiting to running\n- syncing: sync is currently running",,,,,,,,,,,,,,M,
^hisErr,[^str],,,"Error description when `hisStatus` indicates error condition",^lib:phIoT,[^his-point],,,,,,,,,,,,,,,,,,,,,,,,,M,
^writable-point,[^point],,,"Point with writable output using 16-level priority array.  Writable\npoints typically are a setpoint or actuator command.  Haystack writable\npoints are modeled on the BACnet 16-level priority array with a\nrelinquish default which effectively acts as level 17.\nThe following levels have special behavior:\n- **Level 1**: highest priority reserved for emergency overrides\n- **Level 8**: manual override with ability to set timer to expire back to auto\n- **Default**: implicitly acts as level 17 for relinquish default\nThe priority array provides for contention resolution when many different\ncontrol applications may be vying for control of a given point. Low level\napplications like scheduling typically control levels 14, 15, or 16. Then\nusers can override at level 8. But a higher levels like 2 to 7 can be used\nto trump a user override (for example a demand response energy routine\nthat requires higher priority).\nThe actual value to write is resolved by starting at level 1 and working down\nto relinquish default to find the first non-null value. It is possible for\nall levels to be null, in which case the overall write output is null (which\nin turn may be auto/null to another system). Anytime a null value is written\nto a priority level, we say that level has been set to auto or released (this\nallows the next highest level to take command of the output).\nAlso see `docHaystack::Points#writable` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^writeVal,[^scalar],,,"Current desired value to write to output.  This is the current \"winning\"\nvalue of the priority array indicated by `writeLevel`.  If this tag\nis missing then the winning value is null/auto.",^lib:phIoT,[^writable-point],,,,,,,,,,,,,,,,,,,,,,,,,M,
^writeLevel,[^int],,,"Current priority level for `writeVal` as number between 1 and 17.\nThe value 17 indicates the relinquish default value.",^lib:phIoT,[^writable-point],,,,,,,,,,,,,,,,,,,,,,,,1,M,17
^writeStatus,[^str],,,"Current status of a writable point output",^lib:phIoT,[^writable-point],,,,,,,,,,,"- unbound: writable point is not bound to any output\n- ok: last write was successful\n- down: connectivity/networking problem - see `writeErr`\n- fault: configuration or hardware error  - see `writeErr`\n- disabled: manual disable of the point or connector\n- unknown: we don't know anything (typically boot state)",,,,,,,,,,,,,,M,
^writeErr,[^str],,,"Error description when `writeStatus` indicates error condition",^lib:phIoT,[^writable-point],,,,,,,,,,,,,,,,,,,,,,,,,M,
^process,[^marker],,M,"Industrial or HVAC process",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^heating,[^marker],,,"Heating mode or process",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^heatingProcess,[^choice],,,"Processed used to heat a substance",^lib:phIoT,[^airHandlingEquip,^boiler,^chilledBeam,^heatingCoil,^radiator,^radiantFloor,^vav],,,,,,,,,,,,,,,,,,,,,,,,,,
^biomassHeating,[^heatingProcess],,,"Heating by the combustion of biomass",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^coalHeating,[^heatingProcess],,,"Heating by the combustion of coal",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dxHeating,[^heatingProcess],,,"Heating using direct expansion of a refrigerant vapor.\nAlso see `dxCooling` and `heatPump`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hotWaterHeating,[^heatingProcess,^hot-water-input],,,"Heating using energy of hot water",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^propaneHeating,[^heatingProcess],,,"Heating by the combustion of propane",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^steamHeating,[^heatingProcess,^steam-input],,,"Heating using energy of steam",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^naturalGasHeating,[^heatingProcess,^naturalGas-input],,,"Heating by the combustion of natural gas",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^fuelOilHeating,[^heatingProcess,^fuelOil-input],,,"Heating by the combustion of fuel oil",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^elecHeating,[^heatingProcess,^elec-input],,,"Heating by the conversion of electrical energy",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Electric_heating`,,,,,,,,,,,,,,,,,
^cooling,[^marker],,,"Cooling mode or process",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^coolingProcess,[^choice],,,"Processed used to cool a substance",^lib:phIoT,[^airHandlingEquip,^chilledBeam,^coolingCoil],,,,,,,,,,,,,,,,,,,,,,,,,,
^airCooling,[^coolingProcess,^air-input],,,"Cooling by dissipating heat into the surrounding air",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Air_cooling`,,,,,,,,,,,,,,,,,
^condenserCooling,[^coolingProcess],,,"Removal of heat through the process of water condensation",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^dxCooling,[^coolingProcess],,,"Cooling using direct expansion of a refrigerant vapor.\nAlso see `dxHeating` and `heatPump`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^chilledWaterCooling,[^coolingProcess,^chilled-water-input],,,"Cooling using transfer of heat to chilled water",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^waterCooling,[^coolingProcess],,,"Cooling using transfer of heat to water which is not explicitly chilled",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water_cooling`,,,,,,,,,,,,,,,,,
^radiantEquip,[^equip],,,"HVAC equipment that conditions a space without forced air.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^radiator,[^radiantEquip],,,"Heats a space using exposed pipes or coils.  Hot water and steam\nradiators are often cast iron and installed directly in the space\nor along the baseboard.  Electric radiators are typically installed\non the baseboard.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Radiator_(heating)`,,,,,,,,,,[{equip},{point}],,,,,,,
^radiantFloor,[^radiantEquip],,,"Heats a space using pipes or cables embedded beneath floor.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Underfloor_heating`,,,,,,,,,,[{equip},{point}],,,,,,,
^chilledBeam,[^radiantEquip],,,"Conditions a space using a heat exchanger integrated into the ceiling",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Chilled_beam`,,,,,,,,,,[{equip},{point}],,,,,,,
^site,[^entity,^geoPlace],,M,"Site is a geographic location of the built environment.\nTypically site maps to one building with its own unique\nstreet address.  See `docHaystack::Sites` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{space},{equip}],,M,,,,,
^yearBuilt,[^int],,,"Original year of construction as four digit year such as 1980",^lib:phIoT,[^site],,,,,,,,,,,,,,,,,,,,,,,,,,
^primaryFunction,[^str],,,"Primary function of building as US Energy Star key",^lib:phIoT,[^site],,,,,,,,,,,"Adult Education\nAmbulatory Surgical Center\nAquarium\nAutomobile Dealership\nBank Branch\nBar/Nightclub\nBarracks\nBowling Alley\nCasino\nCollege/University\nConvenience Store with Gas Station\nConvenience Store without Gas Station\nConvention Center\nCourthouse\nData Center\nDistribution Center\nDrinking Water Treatment & Distribution\nEnclosed Mall\nEnergy/Power Station\nFast Food Restaurant\nFinancial Office\nFire Station\nFitness Center/Health Club/Gym\nFood Sales\nFood Service\nHospital (General Medical & Surgical)\nHotel\nIce/Curling Rink\nIndoor Arena\nK-12 School\nLaboratory\nLibrary\nLifestyle Center\nMailing Center/Post Office\nManufacturing/Industrial Plant\nMedical Office\nMixed Use Property\nMovie Theater\nMultifamily Housing\nMuseum\nNon-Refrigerated Warehouse\nOffice\nOther - Education\nOther - Entertainment/Public Assembly\nOther - Lodging/Residential\nOther - Mall\nOther - Public Services\nOther - Recreation\nOther - Restaurant/Bar\nOther - Services\nOther - Stadium\nOther - Technology/Science\nOther - Utility\nOther\nOther/Specialty Hospital\nOutpatient Rehabilitation/Physical Therapy\nParking\nPerforming Arts\nPersonal Services (Health/Beauty, Dry Cleaning, etc)\nPolice Station\nPre-school/Daycare\nPrison/Incarceration\nRace Track\nRefrigerated Warehouse\nRepair Services (Vehicle, Shoe, Locksmith, etc)\nResidence Hall/Dormitory\nRestaurant\nRetail Store\nRoller Rink\nSelf-Storage Facility\nSenior Care Community\nSingle Family Home\nSocial/Meeting Hall\nStadium (Closed)\nStadium (Open)\nStrip Mall\nSupermarket/Grocery Store\nSwimming Pool\nTransportation Terminal/Station\nUrgent Care/Clinic/Other Outpatient\nVeterinary Office\nVocational School\nWastewater Treatment Plant\nWholesale Club/Supercenter\nWorship Facility\nZoo",,,,,,,,,,,,,,,
^siteRef,[^ref],^site,,"Reference to site which contains the entity",^lib:phIoT,[^system,^space,^equip,^point],,,,,,,,,,,,,,,,,,,,,,^site,,,,
^space,[^entity],,M,"Space is a three-dimensional volume in the built environment.\nSee `docHaystack::Spaces` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{space},{equip},{point}],,M,,,,,
^area,[^number],,,"Area of a shape or floor space",^lib:phIoT,[^site,^space],,,,,,,,,,,,,,,,,["ft\u00b2","m\u00b2"],,,,,,,,,
^floor,[^space],,,"Storey of a building.  See `docHaystack::Spaces#floors` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Storey`,,,,,,,,,,[{space},{equip},{point}],,,,,,,
^ground-floor,[^floor],,,"Floor at ground level.  In North America this is typically called\nthe first floor, but in Europe its often labeled as floor zero.\nIf `floorNum` is defined, then it must be set to zero.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Storey`,,,,,,,,,,[{space},{equip},{point}],,,,,,,
^subterranean-floor,[^floor],,,"Floor below ground level.  Subterranean floors are also known as\nbasements, lower levels, or cellars.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Storey`,,,,,,,,,,[{space},{equip},{point}],,,,,,,
^roof-floor,[^floor],,,"The roof floor is the topmost level of a building.  It is often\nwhere HVAC equipment is located such as rooftop AHUs.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Storey`,,,,,,,,,,[{space},{equip},{point}],,,,,,,
^floorNum,[^int],,,"Unitless integer indicating the floor's distance from ground level.  The\nground floor is always defined as zero.  Additional floors above ground are\nnumbered 1, 2, 3, etc.  Subterranean floors are numbered -1, -2, -3, etc.\nThis convention is consistent with how most European buildings number\nfloors.  In North America its common to label the ground floor\nas the first floor; however Haystack requires the ground level to be\nassigned a floorNum of 0.",^lib:phIoT,[^floor],,,,,,,,,,,,,,,,,,,,,,,,,,
^room,[^space],,,"Enclosed room of a building",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Room`,,,,,,,,,,[{space},{equip},{point}],,,,,,,
^spaceRef,[^ref],^space,,"Reference to space which contains this entity",^lib:phIoT,[^space,^equip,^point],,,,,,,,,,,,,,,,,,,,,,^space,,,,
^biomass,[^substance],,,"Plant or animal material used as fuel to produce electricity or heat",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Biomass`,,,,,,,,,,,,,,,,,
^coal,[^solid],,,"Combustible sedimentary rock",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Coal`,,,,,,,,,,,,,,,,,
^condensate,[^liquid],,,"Liquid phase produced by the condensation of steam or other gas",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Liquid`,,,,,,,,,,,,,,,,,
^diesel,[^liquid],,,"Liquid fuel specifically designed for use in diesel engines",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Diesel_fuel`,,,,,,,,,,,,,,,,,
^fuelOil,[^liquid],,,"Petroleum based oil burned for energy",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fuel_oil`,,,,,,,,,,,,,,,,,
^naturalGas,[^gas],,,"Fossil fuel energy source consisting largely of methane and other hydrocarbons.\nThe energy content of natural gas varies by region within a range determined\non impurities in the gas.  You can find a table of these conversions\n[here]`https://en.wikipedia.org/wiki/Heat_of_combustion#Higher_heating_values_of_natural_gases_from_various_sources`",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Natural_gas`,,,,,,,,,,,,,,,,,
^propane,[^gas],,,"By-product of natural gas processing and petroleum refining (C\u2083H\u2088)",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Propane`,,,,,,,,,,,,,,,,,
^refrig,[^fluid],,,"Fluid used in refrigeration and heat exchange.  Refrigerants typically\nalternate between liquid and gas state.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Refrigerant`,,,,,,,,,,,,,,,,,
^gasoline,[^liquid],,,"Petroleum derived liquid used as a fuel source",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Gasoline`,,,,,,,,,,,,,,,,,
^blowdown-water,[^water],,,"Water expelled from a system to remove mineral build up",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^domestic-water,[^water],,,"Tap water for drinking, washing, cooking, and flushing of toilets",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^chilled-water,[^water],,,"Water cooled for use in HVAC and industrial processes",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Chilled_water`,,,,,,,,,,,,,,,,,
^cold-water,[^water],,,"Water supplied to cold taps",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^condenser-water,[^water],,,"Water used used to remove heat through condensation",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^cool-water,[^water],,,"Relatively cool water without active chilling",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^ground-water,[^water],,,"Water present under the ground or from a well",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Groundwater`,,,,,,,,,,,,,,,,,
^hot-water,[^water],,,"Hot water used for HVAC heating or supplied to hot taps",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^makeup-water,[^water],,,"Water used used to makeup water loss through leaks, evaporation, or blowdown",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^purge-water,[^water],,,"Water expelled from a system to remove contaminants.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^warm-water,[^water],,,"Relatively warm water without active heating",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Water`,,,,,,,,,,,,,,,,,
^synthetic,[^pointFunction],,,"Synthetic point with computed operational data. The computed data\nif classified as:\n- `ml` for machine learning\n- `sim` for simulation\n- `computed` as catch all for other computations\nSee `docHaystack::Synthetics` chapter.",^lib:phIoT,[^point],,,,,,,,,,,,,,,,,,,,,M,,,,,
^sim,[^synthetic],,,"Simulation point. See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ml,[^synthetic],,,"Machine learning point. See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^computed,[^synthetic],,,"Computed point. See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^synthetic-point,[^point],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^sim-point,[^synthetic-point],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^computed-point,[^synthetic-point],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ml-point,[^synthetic-point],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^pointRef,[^ref],^point,,"See `docHaystack::Synthetics#structure` chapter.",^lib:phIoT,[^sim-point],,,,,,,,,,,,,,,,,,,,,,,,,,
^syntheticModel,[^entity],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,M,,,,,
^syntheticModelRef,[^ref],^syntheticModel,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,[^synthetic-point],,,,,,,,,,,,,,,,,,,,,,,,,,
^simModel,[^syntheticModel],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^mlModel,[^syntheticModel],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^computedModel,[^syntheticModel],,,"See `docHaystack::Synthetics` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^simScenario,[^choice],,,"See `docHaystack::Synthetics#sims` chapter.",^lib:phIoT,[^sim-point],,,,,,,,,,,,,,,,,,,,,,,,,,
^simOperation,[^simScenario],,,"See `docHaystack::Synthetics#sims` chapter.",^lib:phIoT,,,,,,,"Operation",,,,,,,,,,,,,,,,,,,,
^simBaseline,[^simScenario],,,"See `docHaystack::Synthetics#sims` chapter.",^lib:phIoT,,,,,,,"Baseline",,,,,,,,,,,,,,,,,,,,
^simOptimum,[^simScenario],,,"See `docHaystack::Synthetics#sims` chapter.",^lib:phIoT,,,,,,,"Optimum",,,,,,,,,,,,,,,,,,,,
^mlInputVarRefs,[^list],^mlVarRef,,"List of independent variables, also known as model inputs or features,\nassociated with a machine learning model.",^lib:phIoT,[^mlModel],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlOutputVarRef,[^ref],^mlVar,,"Dependent variable, also known as the model output or target,\nassociated, with a machine learning model.\nRepresents the predicted outcome generated by the model.",^lib:phIoT,[^mlModel],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlIdentificationPeriod,[^span],,,"Training period description, known as the identification period\nor baseline, utilized during the model training process.",^lib:phIoT,[^mlModel],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlModelParameters,[^dict],,,"Result of model identification, which may appear as a list of\nmodel parameters for simpler models or as a reference to a stored model,\nin the form of a file uri. The structure of the dict is user-specific.",^lib:phIoT,[^mlModel],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlModelMetrics,[^dict],,,"Goodness-of-fit metrics provided in the form of a simple dictionary.\nFor example: {r2:0.7889, cvrmse:58}.",^lib:phIoT,[^mlModel],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlVar,[^entity],,,"Machine learning variable representing both model inputs and outputs.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,M,,,,,
^mlVarPoint,[^ref],^point,,"Reference to a point associated with a machine learning variable,\nknown as a machine learning variable point.",^lib:phIoT,[^mlVar],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlVarFilter,[^filterStr],,,"Filter used for querying points by tags, providing more flexibility\nthan mlVarPoint, although it is not mandatory.",^lib:phIoT,[^mlVar],,,,,,,,,,,,,,,,,,,,,,,,,,
^mlVarRef,[^ref],^mlVar,,"Reference to a machine learning variable.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^system,[^entity],,M,"Grouping of related equipment dedicated to a single application.\nSee `docHaystack::Systems` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,M,,,,,
^air-system,[^system],,,"System for moving air to maintain indoor thermal comfort and/or air quality.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^air-conditioning-system,[^air-system],,,"System for air treatment to control its temperature, humidity, cleanliness,\nand distribution to meet the requirements of a conditioned space.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^air-exhaust-system,[^air-system],,,"System consisting of one or more fans that remove air from the building.\nExhaust systems allow outdoor air to enter by ventilation inlets or normal\nleakage paths sthrough the building envelope.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^air-ventilation-system,[^air-system],,,"System that supplies or removes air by natural or mechanical means to or\nfrom any space in order to provide outdoor air to the space. Such air may or\nmay not have been conditioned.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^elec-system,[^system],,,"System that generates, converts, distributes, and/or stores electricity.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^lighting-system,[^elec-system],,,"System designed to provide lighting.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^refrig-system,[^system],,,"Refrigerant distribution to fulfill all or parts of a refrigeration cycle.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^water-system,[^system],,,"System that supplies or collects potable or non-potable water in any state.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^chilled-water-system,[^water-system],,,"System that circulates water in its liquid state below ambient temperature\nfor cooling a space or process.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^condenser-water-system,[^water-system],,,"System that circulates water in its liquid state for rejecting heat\nfrom a space or process.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^hot-water-system,[^water-system],,,"System that circulates water in its liquid state for heating\na space or process.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^steam-system,[^water-system],,,"System that circulates water in its vapor state for heating\na space or process.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^domestic-water-system,[^water-system],,,"System that circulates potable water in its liquid state for purposes\nother than space conditioning and process requirements.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^domestic-cold-water-system,[^domestic-water-system],,,"System that circulates potable cold water in its liquid state for purposes\nother than space cooling and process requirements.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^domestic-hot-water-system,[^domestic-water-system],,,"System that circulates potable hot water in its liquid state for purposes\nother than space heating and process requirements.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^systemRef,[^ref],^system,,"Reference to system",^lib:phIoT,[^equip,^point,^system],,,,,,,,,,,,,,,,,,,,,,,,,,
^tank,[^equip],,,"Tank used to store a substance for temporary holding",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Storage_tank`,,,,,,,,,,[{level sensor point},{temp sensor point},{pressure sensor point},{equip},{point}],[^substance],,,,,,
^tankSubstance,[^choice],^substance,,"Substance stored by a tank",^lib:phIoT,[^tank],,,,,,,,,,,,,,,,,,,,,,,,,,
^vav,[^airTerminalUnit],,,"Variable air volume terminal unit.  VAV systems use a constant air\ntemperature with a variable air flow rate.  See `docHaystack::VAVs` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Variable_air_volume`,,,,,,,,,,[{reheat cmd point},{hvacMode sp point},{ductArea sp point},{perimeterHeat cmd point},{thermostat equip},{discharge duct equip},{inlet duct equip},{equip},{point}],,,,,,,
^vavModulation,[^choice],,,"How does VAV modulate the temp based on duct pressure",^lib:phIoT,[^vav],,,,,,,,,,,,,,,,,,,,,,,,,,
^pressureDependent,[^vavModulation],,,"VAV damper modulates to control space temp; dependent on duct pressure\nbeing maintained",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^pressureIndependent,[^vavModulation],,,"VAV damper or a control valve that modulates to maintain desired flow\nsetpoint; independent of the duct pressure",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^vavAirCircuit,[^choice],,,"How does the VAV pull in air",^lib:phIoT,[^vav],,,,,,,,,,,,,,,,,,,,,,,,,,
^vav-series,[^vavAirCircuit],,,"VAV pulls air from the primary air flow",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^vav-parallel,[^vavAirCircuit],,,"VAV pulls air from outside the primary air flow",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^ductArea,[^marker],,,"Config point on a `vav` for duct area measured in ft\u00b2 or m\u00b2",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^hvacMode,[^marker],,,"Operational mode for HVAC equipment",^lib:phIoT,,,,,,,,,,,,"- cooling:\n- heating:\n- reheat:\n- warmup: morning warmup where AHU is supplying warm air\n- purge: night purge when AHU is supplying 100% fresh air\n- pressurize:\n- depressurize:\n- manual:",,,,,,,,,,,,,,,
^perimeterHeat,[^marker],,,"Auxiliary heating points associated with a `vav`",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^verticalTransport,[^equip],,,"Equipment to move humans and materials",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^elevator,[^verticalTransport,^elec-input],,,"Enclosure used to move people between floors.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Elevator`,,,,,,,,,,[{equip},{point}],,,,,,,
^escalator,[^verticalTransport,^elec-input],,,"Moving staircase used to move people between floors.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Escalator`,,,,,,,,,,[{equip},{point}],,,,,,,
^movingWalkway,[^verticalTransport,^elec-input],,,"Conveyor to move people across a horizontal or inclined plane.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Moving_walkway`,,,,,,,,,,[{equip},{point}],,,,,,,
^vrf,[^marker],,,"Variable refigerant flow.  See `docHaystack::VRF` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Variable_refrigerant_flow`,,,,,,,,,,,,,,,,,
^vrf-system,[^refrig-system],,,"Variable refigerant flow system.  The system contains the indoor\nunits, outdoor units, and branch selectors.  See `docHaystack::VRF#types`\nchapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{vrf refrig plant equip},{vrf indoorUnit equip},{vrf outdoorUnit equip},{equip},{point}],,,,,,,
^vrf-coolingOnly-system,[^vrf-system],,,"Cooling only VRF system can only cool; heating is not available.\nSee `docHaystack::VRF#types` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{vrf refrig plant equip},{vrf indoorUnit equip},{vrf outdoorUnit equip},{equip},{point}],,,,,,,
^vrf-heatPump-system,[^vrf-system],,,"Heat pump VRF system can either heat, or cool, but not at the same time.\nSee `docHaystack::VRF#types` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{vrf refrig plant equip},{vrf indoorUnit equip},{vrf outdoorUnit equip},{equip},{point}],,,,,,,
^vrf-heatRecovery-system,[^vrf-system],,,"Heat recovery VRF system can operate cooling and heating by each indoor unit\nindependently, at the same time. Heat recovery VRF systems have branch selectors\nto control how much, and which (hot gas or subcooled liquid) refrigerant\ngoes to each indoor unit.  See `docHaystack::VRF#types` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{vrf branchSelector equip},{vrf refrig plant equip},{vrf indoorUnit equip},{vrf outdoorUnit equip},{equip},{point}],,,,,,,
^vrf-equip,[^equip],,,"Equipment used in VRF systems.  See `docHaystack::VRF#equip` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^vrf-refrig-plant,[^plant,^refrig-output],,,"Group of outdoor units in a VRF system.  See `docHaystack::VRF#refrigPlant`.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{vrf outdoorUnit equip},{enable cmd point},{equip},{point}],,,,,,,
^vrf-outdoorUnit,[^vrf-equip,^refrig-output],,,"Outdoor unit with one or more compressors in a VRF system. As each indoor\nunit sends a demand to the outdoor unit, outdoor unit delivers the amount\nof refrigerant needed to meet the individual requirements of each indoor\nunit.  See `docHaystack::VRF#outdoorUnits` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^vrf-indoorUnit,[^vrf-equip,^refrig-input],,,"Indoor unit in a VRF system.  Indoor units operate to satisfy a heating\nor cooling load. See `docHaystack::VRF#indoorUnits` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^vrf-indoorUnit-fcu,[^vrf-indoorUnit,^fcu],,,"Indoor unit fan coil unit in a VRF system.  This includes but is not\nlimited to: ducted-type and non-ducted types such as wall-mount,\nfloor-mount, ceiling-mount and cassettes.  Indoor unit fan coils operate\nto satisfy a heating  or cooling load in a zone based on a zone thermostat\ntemperature set point.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Fan_coil_unit`,,,,,,,,,,[{equip},{point},{thermostat equip},{discharge duct equip},{exhaust duct equip},{mixed duct equip},{outside duct equip},{ventilation duct equip},{economizer duct equip},{return duct equip},{humidifier equip},{hvacMode sp point},{cool cmd point},{heat cmd point},{filter sensor point},{freezeStat sensor point},{economizing cmd point},{heatWheel cmd point},{dessicantDehumidifier cmd point},{faceBypass cmd point},{bypass damper cmd point}],,,,,,,
^branchSelector,[^vrf-equip,^refrig-input],,,"Branch selector used for heat recovery in a VRF system.  These are\ncontrol devices directing the liquid refrigerant or gas refrigerant\nto zones requiring cooling or heating. See `docHaystack::VRF#branchSelector`\nchapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{equip},{point}],,,,,,,
^heatRecovery,[^marker],,,"Transfer of heat from one substance to another to reduce energy consumption.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^indoorUnit,[^marker],,,"Operates inside the conditioned space",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^outdoorUnit,[^marker],,,"operates outside the conditioned space",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^weatherStation,[^entity,^geoPlace],,,"Logical weather station and its measurement points.\nSee `docHaystack::Weather#stations` chapter.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Weather_station`,,,,,,,,,,[{weather air temp sensor point},{weather air wetBulb sensor point},{weather air feelsLike sensor point},{weather air dewPoint sensor point},{weather air humidity sensor point},{weather air enthalpy sensor point},{weather atmospheric pressure sensor point},{weather cloudage sensor point},{weather daytime sensor point},{weather precipitation sensor point},{weather solar irradiance sensor point},{weather weatherCond sensor point},{weather wind speed sensor point},{weather wind direction sensor point},{weather visibility sensor point}],,M,,,,,
^weather-point,[^point],,,"Weather station observation point.\nSee `docHaystack::Weather#points` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,,,,,,,,
^weatherStationRef,[^ref],^weatherStation,,"Reference to weather station for to use this entity",^lib:phIoT,[^site,^weather-point],,,,,,,,,,,,,,,,,,,,,,,,,,
^zone-space,[^space],,,"Space associated with a specific system.\nSee `docHaystack::Spaces#zones` and `docHaystack::Zones` chapters.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{occupied sensor point},{occupied sp point},{occupancy sensor point},{space},{equip},{point}],,,,,,,
^hvac-zone-space,[^zone-space,^hvacZonePoints,^airQualityZonePoints,^air-input],,,"Zone related to conditioning of a space's air temperature and quality.\nSee `docHaystack::Spaces#zones` and `docHaystack::Zones#hvac` chapters.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{occupied sensor point},{occupied sp point},{occupancy sensor point},{space},{equip},{point},{zone air hvacMode sp point},{zone air temp sensor point},{zone air temp effective sp point},{zone air temp effective cooling sp point},{zone air temp effective heating sp point},{zone air temp occ cooling sp point},{zone air temp occ heating sp point},{zone air temp unocc cooling sp point},{zone air temp unocc heating sp point},{zone air temp standby cooling sp point},{zone air temp standby heating sp point},{zone air pressure sensor point},{zone air pressure sp point},{zone air humidity sensor point},{zone air humidity sp point},{zone air dewPoint sensor point},{zone air dewPoint sp point},{zone air enthalpy sensor point},{zone air enthalpy sp point},{zone air ch2o concentration sensor point},{zone air co concentration sensor point},{zone air co2 concentration sensor point},{zone air co2 concentration sp point},{zone air nh3 concentration sensor point},{zone air no2 concentration sensor point},{zone air o3 concentration sensor point},{zone air pm01 concentration sensor point},{zone air pm10 concentration sensor point},{zone air pm25 concentration sensor point},{zone air tvoc concentration sensor point}],,,,,,,
^lighting-zone-space,[^zone-space,^lightingZonePoints],,,"Zone related to lighting system.\nSee `docHaystack::Spaces#zones` and `docHaystack::Zones#lighting` chapters.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{occupied sensor point},{occupied sp point},{occupancy sensor point},{space},{equip},{point},{light level sensor point},{light level sp point},{light illuminance sensor point},{light luminous flux sensor point}],,,,,,,
^hvacZonePoints,[^pointGroup],,,"Entity with logical grouping of zone HVAC air points.\nSee `docHaystack::Zones#hvac` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{zone air hvacMode sp point},{zone air temp sensor point},{zone air temp effective sp point},{zone air temp effective cooling sp point},{zone air temp effective heating sp point},{zone air temp occ cooling sp point},{zone air temp occ heating sp point},{zone air temp unocc cooling sp point},{zone air temp unocc heating sp point},{zone air temp standby cooling sp point},{zone air temp standby heating sp point},{zone air pressure sensor point},{zone air pressure sp point},{zone air humidity sensor point},{zone air humidity sp point},{zone air dewPoint sensor point},{zone air dewPoint sp point},{zone air enthalpy sensor point},{zone air enthalpy sp point}],,,,,,,
^thermostat,[^equip,^hvacZonePoints],,,"Senses and controls temperature of space in HVAC system.  Thermostats\nmay provide an interface for setpoint control.",^lib:phIoT,,,,,,,,,,`https://en.wikipedia.org/wiki/Thermostat`,,,,,,,,,,[{equip},{point},{zone air hvacMode sp point},{zone air temp sensor point},{zone air temp effective sp point},{zone air temp effective cooling sp point},{zone air temp effective heating sp point},{zone air temp occ cooling sp point},{zone air temp occ heating sp point},{zone air temp unocc cooling sp point},{zone air temp unocc heating sp point},{zone air temp standby cooling sp point},{zone air temp standby heating sp point},{zone air pressure sensor point},{zone air pressure sp point},{zone air humidity sensor point},{zone air humidity sp point},{zone air dewPoint sensor point},{zone air dewPoint sp point},{zone air enthalpy sensor point},{zone air enthalpy sp point}],,,,,,,
^airQualityZonePoints,[^pointGroup],,,"Entity with logical grouping of zone air quality points.\nSee `docHaystack::Zones#airQuality` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{zone air ch2o concentration sensor point},{zone air co concentration sensor point},{zone air co2 concentration sensor point},{zone air co2 concentration sp point},{zone air nh3 concentration sensor point},{zone air no2 concentration sensor point},{zone air o3 concentration sensor point},{zone air pm01 concentration sensor point},{zone air pm10 concentration sensor point},{zone air pm25 concentration sensor point},{zone air tvoc concentration sensor point}],,,,,,,
^lightingZonePoints,[^pointGroup],,,"Entity with logical grouping of lighting points.\nSee `docHaystack::Zones#lighting` chapter.",^lib:phIoT,,,,,,,,,,,,,,,,,,,,[{light level sensor point},{light level sp point},{light illuminance sensor point},{light luminous flux sensor point}],,,,,,,
^dataCenter,[^space],,,"Space used to house computer and networking gear.\nSee `docHaystack::DataCenters` chapter.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Data_center`,,,,,,,,,,[{rack equip},{crac fcu equip},{space},{equip},{point}],,,,,,,
^rack,[^equip],,,"Enclosure or chassis used to mount computer and networking gear.\nDevices are mounted to rails of a standard width, typically 19 or 23\ninches.  Height is measured in *rack units* where one 1U is 1.75 inches.\nA full rack has a height of 42U.\nSee `docHaystack::DataCenters#racks` chapter.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/19-inch_rack`,,,,,,,,,,[{server device},{networking device},{equip},{point}],,,,,,,
^ups,[^equip],,,"Uninterruptible power supply",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Uninterruptible_power_supply`,,,,,,,,,,[{equip},{point}],,,,,,,
^device,[^entity],,M,"Microprocessor based hardware device.  This is the general term for\nall computers, mobile phones, controllers, and I/O modules.\nSee `docHaystack::Devices#networks` chapter.",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,M,,,,,
^deviceRef,[^ref],^device,,"Device which controls a monitors this entity",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^phone,[^device],,,"Telephone used for voice telecommunication.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Telephone`,,,,,,,,,,,,,,,,,
^mobile-phone,[^phone],,,"Cellular phone providing telecommunication over radio links.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Mobile_phone`,,,,,,,,,,,,,,,,,
^tablet,[^device],,,"Mobile device with touch screen for user input.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Tablet_computer`,,,,,,,,,,,,,,,,,
^computer,[^device],,,"General purpose computer.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Computer`,,,,,,,,,,,,,,,,,
^server-computer,[^computer],,,"General purpose computer used as a server.  Typically servers are rack mounted.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Server_(computing)`,,,,,,,,,,,,,,,,,
^laptop,[^computer],,,"Portable laptop computer.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Laptop`,,,,,,,,,,,,,,,,,
^networking-device,[^device],,,"Microprocessor device used to establish networks.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Networking_hardware`,,,,,,,,,,,,,,,,,
^networking-router,[^networking-device],,,"Networking device used to route data between different networks.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Router_(computing)`,,,,,,,,,,,,,,,,,
^networking-switch,[^networking-device],,,"Networking device used to connect devices on the same network.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Network_switch`,,,,,,,,,,,,,,,,,
^controller,[^device],,,"Microprocessor based device used in a control system.  Controllers\ninteract with the physical world through direct I/O to sensors and\nactuators or via network [protocols]`protocol`.",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^controls-panel,[^panel],,,"Panel housing controllers and networking gear",^lib:phIct,,,,,,,,,,,,,,,,,,,,[{controller device},{networking device},{equip},{point}],,,,,,,
^lib:phIct,[^lib],,,"Project Haystack definitions for Information and Communications Technology.\nThis includes microprocessor based hardware, software, and networking\ntechnologies.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Information_and_communications_technology`,,,"3.9.15",`https://project-haystack.org/def/phIct/`,,,,,[^lib:ph,^lib:phIoT],,,,,,,,
^mobile,[^marker],,,"Relating to mobile phones, hand-held computers, and similar technology",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^networking,[^marker],,,"Related to data communication networks",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^router,[^marker],,,"Device used to route data packets",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^server,[^marker],,,"Hardware or software which provides services for other programs or devices.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Server_(computing)`,,,,,,,,,,,,,,,,,
^network,[^entity],,,"Logical communications network between two or more devices.\nSee `docHaystack::Devices#networks` chapter.",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^networkRef,[^ref],^network,,"Associates a device which communicates on specific a network.",^lib:phIct,,,,,,,,,,,,,,,,,,,,,,,,,,,
^protocol,[^marker],,M,"Communication protocol used for devices on a network.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Communication_protocol`,,,,,,,,,,,,,,,,,
^bacnet,[^protocol],,,"ASHRAE building automation and control protocol",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/BACnet`,,,,,,,,,,,,,,,,,
^bluetooth,[^protocol],,,"Short range wireless communication protocol",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Bluetooth`,,,,,,,,,,,,,,,,,
^coap,[^protocol],,,"Constrained Application Protocol",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Constrained_Application_Protocol`,,,,,,,,,,,,,,,,,
^dali,[^protocol],,,"Digital Addressable Lighting Interface protocol for lighting",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Digital_Addressable_Lighting_Interface`,,,,,,,,,,,,,,,,,
^ftp,[^protocol],,,"File Transfer Protocol",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/File_Transfer_Protocol`,,,,,,,,,,,,,,,,,
^haystack,[^protocol],,,"Haystack HTTP protocol for exchanging tagged data",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Communication_protocol`,,,,,,,,,,,,,,,,,
^http,[^protocol],,,"Hypertext Transfer Protocol which is foundation of the web",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol`,,,,,,,,,,,,,,,,,
^imap,[^protocol],,,"Internet Message Access Protocol for retrieving email",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol`,,,,,,,,,,,,,,,,,
^knx,[^protocol],,,"KNX protocol commonly used for lighting systems",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/KNX_(standard)`,,,,,,,,,,,,,,,,,
^modbus,[^protocol],,,"Register based communication protocol used with industrial devices.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Modbus`,,,,,,,,,,,,,,,,,
^mqtt,[^protocol],,,"Message Queuing Telemetry Transport publish/subscribe protocol",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/MQTT`,,,,,,,,,,,,,,,,,
^obix,[^protocol],,,"XML based Open Building Information eXchange protocol.",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/OBIX`,,,,,,,,,,,,,,,,,
^pop3,[^protocol],,,"Post Office Protocol version 3 for retrieving email",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Post_Office_Protocol`,,,,,,,,,,,,,,,,,
^sox,[^protocol],,,"Sedona Framework UDP based communication protocol",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Communication_protocol`,,,,,,,,,,,,,,,,,
^snmp,[^protocol],,,"Simple Network Management Protocol for managing IP devices",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol`,,,,,,,,,,,,,,,,,
^smtp,[^protocol],,,"Simple Mail Transfer Protocol for sending email",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol`,,,,,,,,,,,,,,,,,
^zigbee,[^protocol],,,"Low power wireless communication protocol for home automation",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Zigbee`,,,,,,,,,,,,,,,,,
^zwave,[^protocol],,,"Low power wireless communication protocol for home automation",^lib:phIct,,,,,,,,,,`https://en.wikipedia.org/wiki/Z-Wave`,,,,,,,,,,,,,,,,,