blob: 26020d32c79490f5c4b869a7820ebe87c6a5be7f [file] [log] [blame]
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills6f44b752020-02-06 16:50:51 -06004<!--# Redfish Schema: Sensor v1.0.3 -->
Marri Devender Raod45d2d02019-01-21 10:11:34 -06005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Ed Tanouscb103132019-10-08 11:34:22 -07008<!--# Copyright 2014-2019 DMTF. -->
Marri Devender Raod45d2d02019-01-21 10:11:34 -06009<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
Ed Tanouscb103132019-10-08 11:34:22 -070020 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
21 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
22 </edmx:Reference>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060023 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
28 <edmx:Include Namespace="Resource"/>
29 <edmx:Include Namespace="Resource.v1_0_0"/>
30 </edmx:Reference>
31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PhysicalContext_v1.xml">
32 <edmx:Include Namespace="PhysicalContext"/>
33 </edmx:Reference>
34
35 <edmx:DataServices>
36
37 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Sensor">
38 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
39
40 <EntityType Name="Sensor" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Ed Tanouscb103132019-10-08 11:34:22 -070041 <Annotation Term="OData.Description" String="The Sensor schema describes a sensor and its properties."/>
42 <Annotation Term="OData.LongDescription" String="This Resource represents a Sensor for a Redfish implementation."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060043 <Annotation Term="Capabilities.InsertRestrictions">
44 <Record>
45 <PropertyValue Property="Insertable" Bool="false"/>
46 </Record>
47 </Annotation>
48 <Annotation Term="Capabilities.UpdateRestrictions">
49 <Record>
50 <PropertyValue Property="Updatable" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -070051 <Annotation Term="OData.Description" String="Any writable properties, such as limits and exceptions, can be updated for sensors."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060052 </Record>
53 </Annotation>
54 <Annotation Term="Capabilities.DeleteRestrictions">
55 <Record>
56 <PropertyValue Property="Deletable" Bool="false"/>
57 </Record>
58 </Annotation>
59 <Annotation Term="Redfish.Uris">
60 <Collection>
61 <String>/redfish/v1/Chassis/{ChassisId}/Sensors/{SensorId}</String>
62 </Collection>
63 </Annotation>
64 </EntityType>
65
66 <Action Name="ResetStatistics" IsBound="true">
67 <Parameter Name="Sensor" Type="Sensor.v1_0_0.Actions"/>
Ed Tanouscb103132019-10-08 11:34:22 -070068 <Annotation Term="OData.Description" String="Resets statistics related to this sensor."/>
69 <Annotation Term="OData.LongDescription" String="This action shall reset any time intervals or counted values for this sensor."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060070 </Action>
71
72 </Schema>
73
74 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Sensor.v1_0_0">
75 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
76 <Annotation Term="Redfish.Release" String="2018.3"/>
77
78 <EntityType Name="Sensor" BaseType="Sensor.Sensor">
Marri Devender Raod45d2d02019-01-21 10:11:34 -060079 <Property Name="ReadingType" Type="Sensor.v1_0_0.ReadingType">
80 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070081 <Annotation Term="OData.Description" String="The type of sensor."/>
82 <Annotation Term="OData.LongDescription" String="This property shall contain the type of the sensor."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060083 </Property>
84 <Property Name="DataSourceUri" Type="Edm.String">
85 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070086 <Annotation Term="OData.Description" String="The link to the Resource that provides the data for this sensor."/>
87 <Annotation Term="OData.LongDescription" String="This property shall contain a URI to the Resource that provides the source of the Excerpt contained within this copy."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060088 <Annotation Term="OData.IsURL"/>
89 <Annotation Term="Redfish.ExcerptCopyOnly"/>
90 </Property>
91
Marri Devender Raod45d2d02019-01-21 10:11:34 -060092 <Property Name="Status" Type="Resource.Status" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -070093 <Annotation Term="OData.Description" String="The status and health of the Resource and its subordinate or dependent Resources."/>
94 <Annotation Term="OData.LongDescription" String="This property shall contain the status and health of the Resource and its children."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060095 <Annotation Term="Redfish.Excerpt"/>
96 </Property>
97
98 <Property Name="Reading" Type="Edm.Decimal">
99 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700100 <Annotation Term="OData.Description" String="The sensor value."/>
101 <Annotation Term="OData.LongDescription" String="This property shall contain the sensor value."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600102 <Annotation Term="Redfish.Excerpt"/>
103 </Property>
104 <Property Name="ReadingUnits" Type="Edm.String">
105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700106 <Annotation Term="OData.Description" String="The units of the reading and thresholds."/>
107 <Annotation Term="OData.LongDescription" String="This property shall contain the units of the sensor's reading and thresholds."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600108 <Annotation Term="Redfish.Excerpt"/>
109 </Property>
110 <Property Name="PhysicalContext" Type="PhysicalContext.PhysicalContext">
111 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700112 <Annotation Term="OData.Description" String="The area or device to which this sensor measurement applies."/>
113 <Annotation Term="OData.LongDescription" String="This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies."/>
Gunnar Mills6f44b752020-02-06 16:50:51 -0600114 <Annotation Term="Redfish.Excerpt" String="Array"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600115 </Property>
116 <Property Name="PhysicalSubContext" Type="PhysicalContext.PhysicalSubContext">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700118 <Annotation Term="OData.Description" String="The usage or location within a device to which this sensor measurement applies."/>
119 <Annotation Term="OData.LongDescription" String="This property shall contain a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property generally differentiates multiple sensors within the same PhysicalContext instance."/>
Gunnar Mills6f44b752020-02-06 16:50:51 -0600120 <Annotation Term="Redfish.Excerpt" String="Array"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600121 </Property>
122 <Property Name="PeakReading" Type="Edm.Decimal">
123 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700124 <Annotation Term="OData.Description" String="The peak sensor value."/>
125 <Annotation Term="OData.LongDescription" String="This property shall contain the peak sensor value since the last ResetStatistics action was performed or the service last reset the time-based property values."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600126 </Property>
127
128 <Property Name="MaxAllowableOperatingValue" Type="Edm.Decimal">
129 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700130 <Annotation Term="OData.Description" String="The maximum allowable operating value for this equipment."/>
131 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600132 </Property>
133 <Property Name="MinAllowableOperatingValue" Type="Edm.Decimal">
134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700135 <Annotation Term="OData.Description" String="The minimum allowable operating value for this equipment."/>
136 <Annotation Term="OData.LongDescription" String="This property shall contain the minimum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600137 </Property>
138 <Property Name="AdjustedMaxAllowableOperatingValue" Type="Edm.Decimal">
139 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700140 <Annotation Term="OData.Description" String="The adjusted maximum allowable operating value for this equipment based on the environmental conditions."/>
141 <Annotation Term="OData.LongDescription" String="This property shall contain the adjusted maximum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both. The value is adjusted based on environmental conditions. For example, liquid inlet temperature may be adjusted based on the available liquid pressure."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600142 </Property>
143 <Property Name="AdjustedMinAllowableOperatingValue" Type="Edm.Decimal">
144 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700145 <Annotation Term="OData.Description" String="The adjusted minimum allowable operating value for this equipment based on the environmental conditions."/>
146 <Annotation Term="OData.LongDescription" String="This property shall contain the adjusted minimum allowable operating value for the equipment that this sensor monitors, as specified by a standards body, manufacturer, or both. This value is adjusted based on environmental conditions. For example, liquid inlet temperature may be adjusted based on the available liquid pressure."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600147 </Property>
148
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600149 <Property Name="ApparentVA" Type="Edm.Decimal">
150 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills6f44b752020-02-06 16:50:51 -0600151 <Annotation Term="OData.Description" String="The product of voltage and current for an AC circuit, in Volt-Ampere units."/>
152 <Annotation Term="OData.LongDescription" String="This property shall contain the product of VoltageRMS multiplied by CurrentRMS for a circuit. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values."/>
153 <Annotation Term="Measures.Unit" String="V.A"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600154 <Annotation Term="Redfish.Excerpt" String="Power"/>
155 </Property>
156 <Property Name="ReactiveVAR" Type="Edm.Decimal">
157 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills6f44b752020-02-06 16:50:51 -0600158 <Annotation Term="OData.Description" String="The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units."/>
159 <Annotation Term="OData.LongDescription" String="This property shall contain the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values."/>
160 <Annotation Term="Measures.Unit" String="V.A"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600161 <Annotation Term="Redfish.Excerpt" String="Power"/>
162 </Property>
163 <Property Name="PowerFactor" Type="Edm.Decimal">
164 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700165 <Annotation Term="OData.Description" String="The power factor for this sensor."/>
166 <Annotation Term="OData.LongDescription" String="This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600167 <Annotation Term="Validation.Minimum" Int="0"/>
168 <Annotation Term="Validation.Maximum" Int="1"/>
169 <Annotation Term="Redfish.Excerpt" String="Power"/>
170 </Property>
171 <Property Name="LoadPercent" Type="Edm.Decimal">
172 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700173 <Annotation Term="OData.Description" String="The power load utilization for this sensor."/>
174 <Annotation Term="OData.LongDescription" String="This property shall indicate the power load utilization percent for this sensor. This property may appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values."/>
175 <Annotation Term="Measures.Unit" String="%"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600176 </Property>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600177
Ed Tanouscb103132019-10-08 11:34:22 -0700178 <Property Name="Location" Type="Resource.Location" Nullable="false">
179 <Annotation Term="OData.Description" String="The location information for this sensor."/>
180 <Annotation Term="OData.LongDescription" String="This property shall indicate the location information for this sensor."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600181 </Property>
182 <Property Name="ElectricalContext" Type="Sensor.v1_0_0.ElectricalContext">
183 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
184 <Annotation Term="OData.Description" String="The combination of current-carrying conductors."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700185 <Annotation Term="OData.LongDescription" String="This property shall represent the combination of current-carrying conductors that distribute power."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600186 </Property>
187 <Property Name="VoltageType" Type="Sensor.v1_0_0.VoltageType">
188 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700189 <Annotation Term="OData.Description" String="The voltage type for this sensor."/>
190 <Annotation Term="OData.LongDescription" String="This property shall represent the type of input voltage the sensor monitors."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600191 </Property>
192
Ed Tanouscb103132019-10-08 11:34:22 -0700193 <Property Name="Thresholds" Type="Sensor.v1_0_0.Thresholds" Nullable="false">
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600194 <Annotation Term="OData.Description" String="The set of thresholds defined for this sensor."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700195 <Annotation Term="OData.LongDescription" String="This property shall contain the set of thresholds that derive a sensor's health and operational range."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600196 </Property>
197
198 <Property Name="ReadingRangeMax" Type="Edm.Decimal">
199 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700200 <Annotation Term="OData.Description" String="The maximum possible value for this sensor."/>
201 <Annotation Term="OData.LongDescription" String="This property shall indicate the maximum possible value of the Reading property for this sensor. This value is the range of valid readings for this sensor. Values outside this range are discarded as reading errors."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600202 </Property>
203 <Property Name="ReadingRangeMin" Type="Edm.Decimal">
204 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700205 <Annotation Term="OData.Description" String="The minimum possible value for this sensor."/>
206 <Annotation Term="OData.LongDescription" String="This property shall indicate the minimum possible value of the Reading property for this sensor. This value is the range of valid readings for this sensor. Values outside this range are discarded as reading errors."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600207 </Property>
208 <Property Name="Precision" Type="Edm.Decimal">
209 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700210 <Annotation Term="OData.Description" String="The number of significant digits in the reading."/>
211 <Annotation Term="OData.LongDescription" String="This property shall contain the number of significant digits in the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600212 </Property>
213 <Property Name="Accuracy" Type="Edm.Decimal">
214 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700215 <Annotation Term="OData.Description" String="The estimated percent error of measured versus actual values."/>
216 <Annotation Term="OData.LongDescription" String="This property shall contain the percent error +/- of the measured versus actual values of the Reading property."/>
217 <Annotation Term="Measures.Unit" String="%"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600218 </Property>
219 <Property Name="SensingFrequency" Type="Edm.Decimal">
220 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
221 <Annotation Term="OData.Description" String="The time interval between readings of the physical sensor."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700222 <Annotation Term="OData.LongDescription" String="This property shall contain the time interval between readings of the physical sensor."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600223 </Property>
224 <Property Name="PeakReadingTime" Type="Edm.DateTimeOffset">
225 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700226 <Annotation Term="OData.Description" String="The time when the peak sensor value occurred."/>
227 <Annotation Term="OData.LongDescription" String="This property shall contain the date and time when the peak sensor value was observed."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600228 </Property>
229 <Property Name="SensorResetTime" Type="Edm.DateTimeOffset">
230 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700231 <Annotation Term="OData.Description" String="The date and time when the time-based properties were last reset."/>
232 <Annotation Term="OData.LongDescription" String="This property shall contain the date and time when the ResetStatistics action was last performed or the service last reset the time-based property values."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600233 </Property>
234
235 <Property Name="Actions" Type="Sensor.v1_0_0.Actions" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700236 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
237 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600238 </Property>
239
240 </EntityType>
241
242 <ComplexType Name="Thresholds">
243 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
244 <Annotation Term="OData.Description" String="The set of thresholds defined for a sensor."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700245 <Annotation Term="OData.LongDescription" String="This object shall contain the set of thresholds that derive a sensor's health and operational range."/>
246 <Property Name="UpperCaution" Type="Sensor.v1_0_0.Threshold" Nullable="false">
247 <Annotation Term="OData.Description" String="The value at which the reading is above normal range."/>
248 <Annotation Term="OData.LongDescription" String="This property shall contain the value at which the Reading property is above the normal range. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600249 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700250 <Property Name="UpperCritical" Type="Sensor.v1_0_0.Threshold" Nullable="false">
251 <Annotation Term="OData.Description" String="The value at which the reading is above normal range but not yet fatal."/>
252 <Annotation Term="OData.LongDescription" String="This property shall contain the value at which the Reading property is above the normal range but is not yet fatal. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600253 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700254 <Property Name="UpperFatal" Type="Sensor.v1_0_0.Threshold" Nullable="false">
255 <Annotation Term="OData.Description" String="The value at which the reading is above normal range and fatal."/>
256 <Annotation Term="OData.LongDescription" String="This property shall contain the value at which the Reading property is above the normal range and is fatal. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600257 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700258 <Property Name="LowerCaution" Type="Sensor.v1_0_0.Threshold" Nullable="false">
259 <Annotation Term="OData.Description" String="The value at which the reading is below normal range."/>
260 <Annotation Term="OData.LongDescription" String="This property shall contain the value at which the Reading property is below normal range. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600261 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700262 <Property Name="LowerCritical" Type="Sensor.v1_0_0.Threshold" Nullable="false">
263 <Annotation Term="OData.Description" String="The value at which the reading is below normal range but not yet fatal."/>
264 <Annotation Term="OData.LongDescription" String="This property shall contain the value at which the Reading property is below the normal range but is not yet fatal. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600265 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700266 <Property Name="LowerFatal" Type="Sensor.v1_0_0.Threshold" Nullable="false">
267 <Annotation Term="OData.Description" String="The value at which the reading is below normal range and fatal."/>
268 <Annotation Term="OData.LongDescription" String="This property shall contain the value at which the Reading property is below the normal range and is fatal. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600269 </Property>
270 </ComplexType>
271
272 <ComplexType Name="Threshold">
273 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700274 <Annotation Term="OData.Description" String="The threshold definition for a sensor."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600275 <Annotation Term="OData.LongDescription" String="This type shall contain the properties for an individual threshold for this sensor."/>
276 <Property Name="Reading" Type="Edm.Decimal">
277 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
278 <Annotation Term="OData.Description" String="The threshold value."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700279 <Annotation Term="OData.LongDescription" String="This property shall indicate the reading for this sensor that activates the threshold. The value of the property shall use the same units as the Reading property."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600280 </Property>
281 <Property Name="Activation" Type="Sensor.v1_0_0.ThresholdActivation">
282 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
283 <Annotation Term="OData.Description" String="The direction of crossing that activates this threshold."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700284 <Annotation Term="OData.LongDescription" String="This property shall indicate the direction of crossing of the reading for this sensor that activates the threshold."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600285 </Property>
286 <Property Name="DwellTime" Type="Edm.Duration">
287 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700288 <Annotation Term="OData.Description" String="The duration the sensor value must violate the threshold before the threshold is activated."/>
289 <Annotation Term="OData.LongDescription" String="This property shall indicate the duration the sensor value must violate the threshold before the threshold is activated."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600290 </Property>
291 </ComplexType>
292
293 <ComplexType Name="Actions">
294 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700295 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
296 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600297 <Property Name="Oem" Type="Sensor.v1_0_0.OemActions" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700298 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
299 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600300 </Property>
301 </ComplexType>
302
303 <ComplexType Name="OemActions">
304 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700305 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
306 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600307 </ComplexType>
308
309 <EnumType Name="ThresholdActivation">
310 <Member Name="Increasing">
311 <Annotation Term="OData.Description" String="Value increases above the threshold."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700312 <Annotation Term="OData.LongDescription" String="This threshold is activated when the reading changes from a value lower than the threshold to a value higher than the threshold."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600313 </Member>
314 <Member Name="Decreasing">
315 <Annotation Term="OData.Description" String="Value decreases below the threshold."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700316 <Annotation Term="OData.LongDescription" String="This threshold is activated when the reading changes from a value higher than the threshold to a value lower than the threshold."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600317 </Member>
318 <Member Name="Either">
319 <Annotation Term="OData.Description" String="Value crosses the threshold in either direction."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700320 <Annotation Term="OData.LongDescription" String="This threshold is activated when either the increasing or decreasing conditions are met."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600321 </Member>
322 </EnumType>
323
324 <EnumType Name="ReadingType">
325 <Member Name="Temperature">
326 <Annotation Term="OData.Description" String="Temperature."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700327 <Annotation Term="OData.LongDescription" String="This value shall indicate a temperature measurement, in degrees Celsius units, and the ReadingUnits value shall be 'Cel'."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600328 </Member>
329 <Member Name="Humidity">
330 <Annotation Term="OData.Description" String="Relative Humidity."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700331 <Annotation Term="OData.LongDescription" String="This value shall indicate a relative humidity measurement, in percent units, and the ReadingUnits value shall be '%'."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600332 </Member>
333 <Member Name="Power">
334 <Annotation Term="OData.Description" String="Power."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700335 <Annotation Term="OData.LongDescription" String="This value shall indicate the arithmetic mean of product terms of instantaneous voltage and current values measured over integer number of line cycles for a circuit, in Watt units, and the ReadingUnits value shall be 'W'."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600336 </Member>
337 <Member Name="EnergykWh">
Ed Tanouscb103132019-10-08 11:34:22 -0700338 <Annotation Term="OData.Description" String="Energy (kWh)."/>
339 <Annotation Term="OData.LongDescription" String="This value shall indicate the energy, integral of real power over time, of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in kilowatt-hour units and the ReadingUnits value shall be `kW.h`. This value is used for large-scale energy consumption measurements, while EnergyJoules is used for device-level consumption measurements."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600340 </Member>
341 <Member Name="EnergyJoules">
Ed Tanouscb103132019-10-08 11:34:22 -0700342 <Annotation Term="OData.Description" String="Energy (Joules)."/>
343 <Annotation Term="OData.LongDescription" String="This value shall indicate the energy, integral of real power over time, of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in Joule units and the ReadingUnits value shall be `J`. This value is used for device-level energy consumption measurements, while EnergykWh is used for large-scale consumption measurements."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600344 </Member>
345 <Member Name="Voltage">
346 <Annotation Term="OData.Description" String="Voltage (AC or DC)."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700347 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of the root mean square (RMS) of instantaneous voltage calculated over an integer number of line cycles for a circuit. Voltage is expressed in Volts units and the ReadingUnits value shall be `V`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600348 </Member>
349 <Member Name="Current">
350 <Annotation Term="OData.Description" String="Current."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700351 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of the root mean square (RMS) of instantaneous current calculated over an integer number of line cycles for a circuit. Current is expressed in Amperes units and the ReadingUnits value shall be `A`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600352 </Member>
353 <Member Name="Frequency">
354 <Annotation Term="OData.Description" String="Frequency."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700355 <Annotation Term="OData.LongDescription" String="This value shall indicate a frequency measurement, in Hertz units, and the ReadingUnits value shall be `Hz`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600356 </Member>
357 <Member Name="Pressure">
358 <Annotation Term="OData.Description" String="Pressure."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700359 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of force applied perpendicular to the surface of an object per unit area over which that force is distributed. The ReadingUnits shall be `Pa`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600360 </Member>
361 <Member Name="LiquidLevel">
362 <Annotation Term="OData.Description" String="Liquid level."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700363 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of fluid height relative to a specified vertical datum and the ReadingUnits value shall be `cm`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600364 </Member>
365 <Member Name="Rotational">
366 <Annotation Term="OData.Description" String="Rotational."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700367 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of rotational frequency, in revolutions per minute unit, and the ReadingUnits value shall be `RPM`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600368 </Member>
369 <Member Name="AirFlow">
370 <Annotation Term="OData.Description" String="Airflow."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700371 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of a volume of gas per unit of time that flows through a particular junction. The ReadingUnits shall be `cft_i/min`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600372 </Member>
373 <Member Name="LiquidFlow">
374 <Annotation Term="OData.Description" String="Liquid flow."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700375 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of a volume of liquid per unit of time that flows through a particular junction. The ReadingUnits shall be `L/s`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600376 </Member>
377 <Member Name="Barometric">
Ed Tanouscb103132019-10-08 11:34:22 -0700378 <Annotation Term="OData.Description" String="Barometric pressure."/>
379 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of barometric pressure, in millimeters, of a mercury column, and the ReadingUnits value shall be `mm[Hg]`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600380 </Member>
381 <Member Name="Altitude">
382 <Annotation Term="OData.Description" String="Altitude."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700383 <Annotation Term="OData.LongDescription" String="This value shall indicate a measurement of altitude, in meter units, and the ReadingUnits value shall be `m`."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600384 </Member>
385 </EnumType>
386
387 <EnumType Name="VoltageType">
388 <Member Name="AC">
Ed Tanouscb103132019-10-08 11:34:22 -0700389 <Annotation Term="OData.Description" String="Alternating current."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600390 </Member>
391 <Member Name="DC">
Ed Tanouscb103132019-10-08 11:34:22 -0700392 <Annotation Term="OData.Description" String="Direct durrent."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600393 </Member>
394 </EnumType>
395
396 <EnumType Name="ElectricalContext">
397 <Member Name="Line1">
Ed Tanouscb103132019-10-08 11:34:22 -0700398 <Annotation Term="OData.Description" String="The circuits that share the L1 current-carrying conductor."/>
399 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits that share the L1 current-carrying conductor when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600400 </Member>
401 <Member Name="Line2">
Ed Tanouscb103132019-10-08 11:34:22 -0700402 <Annotation Term="OData.Description" String="The circuits that share the L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire, TwoPhase4Wire, or ThreePhase5Wire."/>
403 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits that share the L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire, TwoPhase4Wire, or ThreePhase5Wire."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600404 </Member>
405 <Member Name="Line3">
Ed Tanouscb103132019-10-08 11:34:22 -0700406 <Annotation Term="OData.Description" String="The circuits that share the L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire."/>
407 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits that share the L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600408 </Member>
409 <Member Name="Neutral">
410 <Annotation Term="OData.Description" String="The grounded current-carrying return circuit of current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, or ThreePhase5Wire."/>
411 <Annotation Term="OData.LongDescription" String="This property shall contain the grounded current-carrying return circuit of current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, or ThreePhase5Wire."/>
412 </Member>
413 <Member Name="LineToLine">
414 <Annotation Term="OData.Description" String="The circuit formed by two current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
415 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by two current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
416 </Member>
417 <Member Name="Line1ToLine2">
418 <Annotation Term="OData.Description" String="The circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
419 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
420 </Member>
421 <Member Name="Line2ToLine3">
422 <Annotation Term="OData.Description" String="The circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire."/>
423 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire."/>
424 </Member>
425 <Member Name="Line3ToLine1">
426 <Annotation Term="OData.Description" String="The circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire."/>
427 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire."/>
428 </Member>
429 <Member Name="LineToNeutral">
430 <Annotation Term="OData.Description" String="The circuit formed by a line and Neutral current-carrying conductor when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
431 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by a line and Neutral current-carrying conductor when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
432 </Member>
433 <Member Name="Line1ToNeutral">
434 <Annotation Term="OData.Description" String="The circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
435 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire."/>
436 </Member>
437 <Member Name="Line2ToNeutral">
438 <Annotation Term="OData.Description" String="The circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire."/>
439 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire."/>
440 </Member>
441 <Member Name="Line3ToNeutral">
442 <Annotation Term="OData.Description" String="The circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire."/>
443 <Annotation Term="OData.LongDescription" String="This property shall contain the circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire."/>
444 </Member>
445 <Member Name="Line1ToNeutralAndL1L2">
446 <Annotation Term="OData.Description" String="The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire."/>
447 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire."/>
448 </Member>
449 <Member Name="Line2ToNeutralAndL1L2">
450 <Annotation Term="OData.Description" String="The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire."/>
451 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire."/>
452 </Member>
453 <Member Name="Line2ToNeutralAndL2L3">
454 <Annotation Term="OData.Description" String="The circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire."/>
455 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire."/>
456 </Member>
457 <Member Name="Line3ToNeutralAndL3L1">
458 <Annotation Term="OData.Description" String="The circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire."/>
459 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire."/>
460 </Member>
461 <Member Name="Total">
462 <Annotation Term="OData.Description" String="The circuits formed by all current-carrying conductors for any PhaseWiringType."/>
463 <Annotation Term="OData.LongDescription" String="This property shall contain the circuits formed by all current-carrying conductors for any PhaseWiringType."/>
464 </Member>
465 </EnumType>
Ed Tanouscb103132019-10-08 11:34:22 -0700466 </Schema>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600467
Ed Tanouscb103132019-10-08 11:34:22 -0700468 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Sensor.v1_0_1">
469 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
470 <Annotation Term="OData.Description" String="This version was created to correct the ReadingUnits definition for the EnergykWh ReadingType and the EnergykWh and EnergyJoules descriptions. It also forces the regeneration of JSON Schema so that URI properties use the uri-reference format, and to add a missing term on several properties to not allow them to be null."/>
471 <EntityType Name="Sensor" BaseType="Sensor.v1_0_0.Sensor"/>
472 </Schema>
473
474 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Sensor.v1_0_2">
475 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
476 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
477 <EntityType Name="Sensor" BaseType="Sensor.v1_0_1.Sensor"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600478 </Schema>
479
Gunnar Mills6f44b752020-02-06 16:50:51 -0600480 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Sensor.v1_0_3">
481 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
482 <Annotation Term="OData.Description" String="This version was created to remove the excerpt annotation from the LoadPercent and PeakReading properties, and to provide a specific excerpt type for PhysicalContext and PhysicalSubContext. It was also created to add unit annotations for ApparentVA and ReactiveVAR properties."/>
483 <EntityType Name="Sensor" BaseType="Sensor.v1_0_2.Sensor"/>
484 </Schema>
485
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600486 </edmx:DataServices>
487</edmx:Edmx>