1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################       -->
4<!--# Redfish Schema:  BatteryMetrics v1.0.4                                               -->
5<!--#                                                                                      -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8<!--# Copyright 2014-2024 DMTF.                                                            -->
9<!--# 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>
20  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
23  </edmx:Reference>
24  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
25    <edmx:Include Namespace="Resource"/>
26    <edmx:Include Namespace="Resource.v1_0_0"/>
27  </edmx:Reference>
28  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
29    <edmx:Include Namespace="Sensor"/>
30  </edmx:Reference>
31
32  <edmx:DataServices>
33
34    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="BatteryMetrics">
35      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
36      <Annotation Term="Redfish.Language" String="en"/>
37
38      <EntityType Name="BatteryMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true">
39        <Annotation Term="OData.Description" String="The `BatteryMetrics` schema contains definitions for the metrics of a battery unit."/>
40        <Annotation Term="OData.LongDescription" String="This resource shall be used to represent the metrics of a battery unit for a Redfish implementation."/>
41        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
42        <Annotation Term="Capabilities.InsertRestrictions">
43          <Record>
44            <PropertyValue Property="Insertable" Bool="false"/>
45          </Record>
46        </Annotation>
47        <Annotation Term="Capabilities.UpdateRestrictions">
48          <Record>
49            <PropertyValue Property="Updatable" Bool="false"/>
50          </Record>
51        </Annotation>
52        <Annotation Term="Capabilities.DeleteRestrictions">
53          <Record>
54            <PropertyValue Property="Deletable" Bool="false"/>
55          </Record>
56        </Annotation>
57        <Annotation Term="Redfish.Uris">
58          <Collection>
59            <String>/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}/Metrics</String>
60          </Collection>
61        </Annotation>
62      </EntityType>
63    </Schema>
64
65    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="BatteryMetrics.v1_0_0">
66      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
67      <Annotation Term="Redfish.Release" String="2021.2"/>
68
69      <EntityType Name="BatteryMetrics" BaseType="BatteryMetrics.BatteryMetrics">
70        <Property Name="Status" Type="Resource.Status" Nullable="false">
71          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
72          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
73        </Property>
74        <Property Name="DischargeCycles" Type="Edm.Decimal">
75          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
76          <Annotation Term="OData.Description" String="The number of discharges this battery has sustained."/>
77          <Annotation Term="OData.LongDescription" String="This property shall contain the number of discharges this battery has sustained."/>
78          <Annotation Term="Validation.Minimum" Int="0"/>
79        </Property>
80        <NavigationProperty Name="InputVoltage" Type="Sensor.Sensor" Nullable="false">
81          <Annotation Term="OData.Description" String="The input voltage (V) for this battery."/>
82          <Annotation Term="OData.LongDescription" String="This property shall contain the input voltage, in volt units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`."/>
83          <Annotation Term="Redfish.ExcerptCopy" String="Voltage"/>
84        </NavigationProperty>
85        <NavigationProperty Name="InputCurrentAmps" Type="Sensor.Sensor" Nullable="false">
86          <Annotation Term="OData.Description" String="The input current (A) for this battery."/>
87          <Annotation Term="OData.LongDescription" String="This property shall contain the input current, in ampere units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`."/>
88          <Annotation Term="Redfish.ExcerptCopy" String="Current"/>
89        </NavigationProperty>
90        <NavigationProperty Name="OutputVoltages" Type="Collection(Sensor.Sensor)">
91          <Annotation Term="OData.Description" String="The output voltages (V) for this battery."/>
92          <Annotation Term="OData.LongDescription" String="This property shall contain the output voltages, in volt units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`.  The sensors shall appear in the same array order as the `OutputCurrentAmps` property."/>
93          <Annotation Term="Redfish.ExcerptCopy" String="Voltage"/>
94        </NavigationProperty>
95        <NavigationProperty Name="OutputCurrentAmps" Type="Collection(Sensor.Sensor)">
96          <Annotation Term="OData.Description" String="The output currents (A) for this battery."/>
97          <Annotation Term="OData.LongDescription" String="This property shall contain the output currents, in ampere units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`.  The sensors shall appear in the same array order as the `OutputVoltages` property."/>
98          <Annotation Term="Redfish.ExcerptCopy" String="Current"/>
99        </NavigationProperty>
100        <NavigationProperty Name="StoredEnergyWattHours" Type="Sensor.Sensor" Nullable="false">
101          <Annotation Term="OData.Description" String="The energy (Wh) stored in this battery."/>
102          <Annotation Term="OData.LongDescription" String="This property shall contain the stored energy, in watt-hour units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergyWh`."/>
103          <Annotation Term="Redfish.ExcerptCopy"/>
104        </NavigationProperty>
105        <NavigationProperty Name="StoredChargeAmpHours" Type="Sensor.Sensor" Nullable="false">
106          <Annotation Term="OData.Description" String="The charge (Ah) stored in this battery."/>
107          <Annotation Term="OData.LongDescription" String="This property shall contain the stored charge, in ampere-hour units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `ChargeAh`."/>
108          <Annotation Term="Redfish.ExcerptCopy"/>
109        </NavigationProperty>
110        <NavigationProperty Name="TemperatureCelsius" Type="Sensor.Sensor" Nullable="false">
111          <Annotation Term="OData.Description" String="The temperature (C) for this battery."/>
112          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature, in degree Celsius units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
113          <Annotation Term="Redfish.ExcerptCopy"/>
114        </NavigationProperty>
115        <NavigationProperty Name="ChargePercent" Type="Sensor.Sensor" Nullable="false">
116          <Annotation Term="OData.Description" String="The amount of charge available (percent) in this battery."/>
117          <Annotation Term="OData.LongDescription" String="This property shall contain the amount of charge available, in percent units, typically `0` to `100`, in this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Percent`."/>
118          <Annotation Term="Redfish.ExcerptCopy"/>
119        </NavigationProperty>
120        <NavigationProperty Name="CellVoltages" Type="Collection(Sensor.Sensor)">
121          <Annotation Term="OData.Description" String="The cell voltages (V) for this battery."/>
122          <Annotation Term="OData.LongDescription" String="This property shall contain the cell voltages, in volt units, for this battery.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`."/>
123          <Annotation Term="Redfish.ExcerptCopy" String="Voltage"/>
124        </NavigationProperty>
125        <Property Name="Actions" Type="BatteryMetrics.v1_0_0.Actions" Nullable="false">
126          <Annotation Term="OData.Description" String="The available actions for this resource."/>
127          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
128        </Property>
129      </EntityType>
130
131      <ComplexType Name="Actions">
132        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
133        <Annotation Term="OData.Description" String="The available actions for this resource."/>
134        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
135        <Property Name="Oem" Type="BatteryMetrics.v1_0_0.OemActions" Nullable="false">
136          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
137          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
138        </Property>
139      </ComplexType>
140
141      <ComplexType Name="OemActions">
142        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
143        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
144        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
145      </ComplexType>
146    </Schema>
147
148    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="BatteryMetrics.v1_0_1">
149      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
150      <Annotation Term="OData.Description" String="This version was created to update descriptions to tie excerpt property definitions to a specific type of `Sensor` or `Control` resource."/>
151      <EntityType Name="BatteryMetrics" BaseType="BatteryMetrics.v1_0_0.BatteryMetrics"/>
152    </Schema>
153
154    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="BatteryMetrics.v1_0_2">
155      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
156      <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/>
157      <EntityType Name="BatteryMetrics" BaseType="BatteryMetrics.v1_0_1.BatteryMetrics"/>
158    </Schema>
159
160    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="BatteryMetrics.v1_0_3">
161      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
162      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
163      <EntityType Name="BatteryMetrics" BaseType="BatteryMetrics.v1_0_2.BatteryMetrics"/>
164    </Schema>
165
166    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="BatteryMetrics.v1_0_4">
167      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
168      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
169      <EntityType Name="BatteryMetrics" BaseType="BatteryMetrics.v1_0_3.BatteryMetrics"/>
170    </Schema>
171
172  </edmx:DataServices>
173</edmx:Edmx>
174