| <?xml version="1.0"?> |
| <!--
|
| Copyright (C) Connectivity Standards Alliance (2021). All rights reserved.
|
| The information within this document is the property of the Connectivity
|
| Standards Alliance and its use and disclosure are restricted, except as
|
| expressly set forth herein.
|
|
|
| Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
|
| nontransferable, worldwide, limited and revocable license (without the right to
|
| sublicense), under Connectivity Standards Alliance's applicable copyright
|
| rights, to view, download, save, reproduce and use the document solely for your
|
| own internal purposes and in accordance with the terms of the license set forth
|
| herein. This license does not authorize you to, and you expressly warrant that
|
| you shall not: (a) permit others (outside your organization) to use this
|
| document; (b) post or publish this document; (c) modify, adapt, translate, or
|
| otherwise change this document in any manner or create any derivative work
|
| based on this document; (d) remove or modify any notice or label on this
|
| document, including this Copyright Notice, License and Disclaimer. The
|
| Connectivity Standards Alliance does not grant you any license hereunder other
|
| than as expressly stated herein.
|
|
|
| Elements of this document may be subject to third party intellectual property
|
| rights, including without limitation, patent, copyright or trademark rights,
|
| and any such third party may or may not be a member of the Connectivity
|
| Standards Alliance. Connectivity Standards Alliance members grant other
|
| Connectivity Standards Alliance members certain intellectual property rights as
|
| set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
|
| Standards Alliance members do not grant you any rights under this license. The
|
| Connectivity Standards Alliance is not responsible for, and shall not be held
|
| responsible in any manner for, identifying or failing to identify any or all
|
| such third party intellectual property rights. Please visit www.csa-iot.org for
|
| more information on how to become a member of the Connectivity Standards
|
| Alliance.
|
|
|
| This document and the information contained herein are provided on an “AS IS”
|
| basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
|
| OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
|
| INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
|
| WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
|
| OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
|
| FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
|
| CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
|
| BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
|
| DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
|
| DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
|
| OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
| LOSS OR DAMAGE.
|
|
|
| All company, brand and product names in this document may be trademarks that
|
| are the sole property of their respective owners.
|
|
|
| This notice and disclaimer must be included on all copies of this document.
|
|
|
| Connectivity Standards Alliance
|
| 508 Second Street, Suite 206
|
| Davis, CA 95616, USA
|
|
|
| :xrefstyle: short
|
| --> |
| <cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x009A" name="Energy Calendar" revision="3"> |
| <revisionHistory> |
| <revision revision="1" summary="mandatory global ClusterRevision attribute added; Added from SE1.4; CCB 2068"/> |
| <revision revision="2" summary="CCB 3042"/> |
| <revision revision="3" summary="Initial Matter Release"/> |
| </revisionHistory> |
| <clusterIds> |
| <clusterId id="0x009A" name="Energy Calendar"/> |
| </clusterIds> |
| <classification hierarchy="base" role="application" picsCode="SECA" scope="Endpoint"/> |
| <features> |
| <feature bit="0" code="PTIER" name="PricingTier" summary="Supports information about pricing tiers"> |
| <optionalConform choice="a" more="true"/> |
| </feature> |
| <feature bit="1" code="FCRED" name="FriendlyCredit" summary="Supports information about when friendly credit periods begin and end"> |
| <optionalConform choice="a" more="true"/> |
| </feature> |
| <feature bit="2" code="AUXLD" name="AuxiliaryLoad" summary="Supports information about when auxiliary loads should be enabled or disabled"> |
| <optionalConform choice="a" more="true"/> |
| </feature> |
| <feature bit="3" code="PEAKP" name="PeakPeriod" summary="Supports information about peak periods"> |
| <optionalConform/> |
| </feature> |
| </features> |
| <dataTypes> |
| <enum name="PeakPeriodSeverityEnum"> |
| <item value="0" name="Unused"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Low"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="Medium"> |
| <mandatoryConform/> |
| </item> |
| <item value="3" name="High"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <enum name="TimeReferenceEnum"> |
| <item value="0" name="UTC" summary="UTC Time"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Standard" summary="UTC time adjusted to local time zone"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="Local" summary="Standard time, adjusted to DST"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <bitmap name="AuxiliaryLoadBitmap"> |
| <bitfield name="AuxiliarySwitch1" bit="0" summary="Auxiliary Switch 1"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch2" bit="1" summary="Auxiliary Switch 2"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch3" bit="2" summary="Auxiliary Switch 3"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch4" bit="3" summary="Auxiliary Switch 4"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch5" bit="4" summary="Auxiliary Switch 5"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch6" bit="5" summary="Auxiliary Switch 6"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch7" bit="6" summary="Auxiliary Switch 7"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="AuxiliarySwitch8" bit="7" summary="Auxiliary Switch 8"> |
| <mandatoryConform/> |
| </bitfield> |
| </bitmap> |
| <bitmap name="TransitionDayOfWeekBitmap"> |
| <bitfield name="Sunday" bit="0" summary="Sunday"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="Monday" bit="1" summary="Monday"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="Tuesday" bit="2" summary="Tuesday"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="Wednesday" bit="3" summary="Wednesday"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="Thursday" bit="4" summary="Thursday"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="Friday" bit="5" summary="Friday"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="Saturday" bit="6" summary="Saturday"> |
| <mandatoryConform/> |
| </bitfield> |
| </bitmap> |
| <struct name="CalendarPeriod"> |
| <field id="0" name="StartDate" type="epoch-s"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="Days" type="list"> |
| <entry type="DayStruct"/> |
| <mandatoryConform/> |
| <constraint type="minCount" value="1"/> |
| </field> |
| </struct> |
| <struct name="DayStruct"> |
| <field id="0" name="Date" type="epoch-s"> |
| <optionalConform choice="a"/> |
| <constraint type="desc"/> |
| </field> |
| <field id="1" name="DaysOfWeek" type="TransitionDayOfWeekBitmap"> |
| <optionalConform choice="a"/> |
| <constraint type="desc"/> |
| </field> |
| <field id="2" name="Transitions" type="list"> |
| <entry type="TransitionStruct"/> |
| <mandatoryConform/> |
| <constraint type="minCount" value="1"/> |
| </field> |
| </struct> |
| <struct name="PeakPeriodStatusStruct"> |
| <field id="0" name="CurrentDaySeverity" type="PeakPeriodSeverityEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="NextDaySeverity" type="PeakPeriodSeverityEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="PeakPeriod" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="PeakPeriodPriorNotice" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| </struct> |
| <struct name="TransitionStruct"> |
| <field id="0" name="TransitionTime" type="uint16"> |
| <mandatoryConform/> |
| <constraint type="between" from="0" to="1439"/> |
| </field> |
| <field id="1" name="PriceTier" type="uint32"> |
| <optionalConform choice="a" more="true"> |
| <feature name="PTIER"/> |
| </optionalConform> |
| </field> |
| <field id="2" name="FriendlyCredit" type="bool"> |
| <optionalConform choice="a" more="true"> |
| <feature name="FCRED"/> |
| </optionalConform> |
| </field> |
| <field id="3" name="AuxiliaryLoad" type="AuxiliaryLoadBitmap"> |
| <optionalConform choice="a" more="true"> |
| <feature name="AUXLD"/> |
| </optionalConform> |
| </field> |
| </struct> |
| </dataTypes> |
| <attributes> |
| <attribute id="0x0000" name="CalendarID" type="uint32" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x0001" name="Name" type="string" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| <constraint type="maxLength" value="12"/> |
| </attribute> |
| <attribute id="0x0002" name="ProviderID" type="uint32" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x0003" name="EventID" type="uint32" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x0004" name="StartDate" type="epoch-s" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x0005" name="TimeReference" type="TimeReferenceEnum" default="UTC"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x0006" name="CalendarPeriods" type="list" default="empty"> |
| <entry type="CalendarPeriod"/> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x0007" name="SpecialDays" type="list" default="empty"> |
| <entry type="DayStruct"/> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x000A" name="CurrentDay" type="DayStruct" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x000D" name="NextDay" type="DayStruct" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x000D" name="CurrentTransition" type="TransitionStruct" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform/> |
| </attribute> |
| <attribute id="0x000F" name="PeakPeriodStatus" type="PeakPeriodStatusStruct" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform> |
| <feature name="PEAKP"/> |
| </mandatoryConform> |
| </attribute> |
| <attribute id="0x0010" name="PeakPeriodStartTime" type="epoch-s" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform> |
| <feature name="PEAKP"/> |
| </mandatoryConform> |
| </attribute> |
| <attribute id="0x0011" name="PeakPeriodEndTime" type="epoch-s" default="null"> |
| <access read="true" readPrivilege="view"/> |
| <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false"/> |
| <mandatoryConform> |
| <feature name="PEAKP"/> |
| </mandatoryConform> |
| </attribute> |
| </attributes> |
| </cluster> |
