xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/AutomationInstrumentation_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1*c6d7a45dSGunnar Mills<?xml version="1.0" encoding="UTF-8"?>
2*c6d7a45dSGunnar Mills<!---->
3*c6d7a45dSGunnar Mills<!--################################################################################       -->
4*c6d7a45dSGunnar Mills<!--# Redfish Schema:  AutomationInstrumentation v1.0.0                                    -->
5*c6d7a45dSGunnar Mills<!--#                                                                                      -->
6*c6d7a45dSGunnar Mills<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7*c6d7a45dSGunnar Mills<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8*c6d7a45dSGunnar Mills<!--# Copyright 2014-2025 DMTF.                                                                 -->
9*c6d7a45dSGunnar Mills<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10*c6d7a45dSGunnar Mills<!--################################################################################       -->
11*c6d7a45dSGunnar Mills<!---->
12*c6d7a45dSGunnar Mills<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13*c6d7a45dSGunnar Mills
14*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16*c6d7a45dSGunnar Mills  </edmx:Reference>
17*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19*c6d7a45dSGunnar Mills  </edmx:Reference>
20*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21*c6d7a45dSGunnar Mills    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22*c6d7a45dSGunnar Mills  </edmx:Reference>
23*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Resource"/>
25*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Resource.v1_0_0"/>
26*c6d7a45dSGunnar Mills  </edmx:Reference>
27*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
28*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Sensor"/>
29*c6d7a45dSGunnar Mills  </edmx:Reference>
30*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Control_v1.xml">
31*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Control"/>
32*c6d7a45dSGunnar Mills  </edmx:Reference>
33*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/AutomationNode_v1.xml">
34*c6d7a45dSGunnar Mills    <edmx:Include Namespace="AutomationNode"/>
35*c6d7a45dSGunnar Mills  </edmx:Reference>
36*c6d7a45dSGunnar Mills
37*c6d7a45dSGunnar Mills  <edmx:DataServices>
38*c6d7a45dSGunnar Mills
39*c6d7a45dSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AutomationInstrumentation">
40*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41*c6d7a45dSGunnar Mills
42*c6d7a45dSGunnar Mills      <EntityType Name="AutomationInstrumentation" BaseType="Resource.v1_0_0.Resource" Abstract="true">
43*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The `AutomationInstrumentation` schema contains measurements and set points for an automation node."/>
44*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This resource shall represent automation node instrumentation for a Redfish implementation."/>
45*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.InsertRestrictions">
46*c6d7a45dSGunnar Mills          <Record>
47*c6d7a45dSGunnar Mills            <PropertyValue Property="Insertable" Bool="false"/>
48*c6d7a45dSGunnar Mills          </Record>
49*c6d7a45dSGunnar Mills        </Annotation>
50*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.UpdateRestrictions">
51*c6d7a45dSGunnar Mills          <Record>
52*c6d7a45dSGunnar Mills            <PropertyValue Property="Updatable" Bool="true"/>
53*c6d7a45dSGunnar Mills          </Record>
54*c6d7a45dSGunnar Mills        </Annotation>
55*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.DeleteRestrictions">
56*c6d7a45dSGunnar Mills          <Record>
57*c6d7a45dSGunnar Mills            <PropertyValue Property="Deletable" Bool="false"/>
58*c6d7a45dSGunnar Mills          </Record>
59*c6d7a45dSGunnar Mills        </Annotation>
60*c6d7a45dSGunnar Mills        <Annotation Term="Redfish.Uris">
61*c6d7a45dSGunnar Mills          <Collection>
62*c6d7a45dSGunnar Mills            <String>/redfish/v1/AutomationNodes/{AutomationNodeId}/AutomationInstrumentation</String>
63*c6d7a45dSGunnar Mills          </Collection>
64*c6d7a45dSGunnar Mills        </Annotation>
65*c6d7a45dSGunnar Mills      </EntityType>
66*c6d7a45dSGunnar Mills    </Schema>
67*c6d7a45dSGunnar Mills
68*c6d7a45dSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AutomationInstrumentation.v1_0_0">
69*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
70*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.Release" String="2025.2"/>
71*c6d7a45dSGunnar Mills
72*c6d7a45dSGunnar Mills      <EntityType Name="AutomationInstrumentation" BaseType="AutomationInstrumentation.AutomationInstrumentation">
73*c6d7a45dSGunnar Mills        <Property Name="NodeState" Type="AutomationNode.NodeState" Nullable="false">
74*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
75*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The current state of the node."/>
76*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This parameter shall specify the current state of the automation node."/>
77*c6d7a45dSGunnar Mills        </Property>
78*c6d7a45dSGunnar Mills        <Property Name="Status" Type="Resource.Status" Nullable="false">
79*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The status and health of a resource and its children."/>
80*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This type shall contain any status or health properties of a resource."/>
81*c6d7a45dSGunnar Mills        </Property>
82*c6d7a45dSGunnar Mills        <NavigationProperty Name="PID" Type="Control.Control">
83*c6d7a45dSGunnar Mills          <Annotation Term="Redfish.ExcerptCopy" String="SingleLoop"/>
84*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="A PID control loop."/>
85*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain a PID-based control loop for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control`."/>
86*c6d7a45dSGunnar Mills        </NavigationProperty>
87*c6d7a45dSGunnar Mills        <NavigationProperty Name="NodeControl" Type="Control.Control">
88*c6d7a45dSGunnar Mills          <Annotation Term="Redfish.ExcerptCopy" String="Node"/>
89*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The control for this node."/>
90*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the control for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control`."/>
91*c6d7a45dSGunnar Mills        </NavigationProperty>
92*c6d7a45dSGunnar Mills        <NavigationProperty Name="TemperatureCelsius" Type="Sensor.Sensor">
93*c6d7a45dSGunnar Mills          <Annotation Term="Redfish.ExcerptCopy"/>
94*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="Temperature (Celsius)."/>
95*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature, in degree Celsius units, for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
96*c6d7a45dSGunnar Mills        </NavigationProperty>
97*c6d7a45dSGunnar Mills        <NavigationProperty Name="Voltage" Type="Sensor.Sensor">
98*c6d7a45dSGunnar Mills          <Annotation Term="Redfish.ExcerptCopy" String="Voltage"/>
99*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The voltage (V) for this node."/>
100*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the voltage, in volt units, for this automation node.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`."/>
101*c6d7a45dSGunnar Mills        </NavigationProperty>
102*c6d7a45dSGunnar Mills        <NavigationProperty Name="CurrentAmps" Type="Sensor.Sensor">
103*c6d7a45dSGunnar Mills          <Annotation Term="Redfish.ExcerptCopy" String="Current"/>
104*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The current (A) for this node."/>
105*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the current, in ampere units, for this automation node.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`."/>
106*c6d7a45dSGunnar Mills        </NavigationProperty>
107*c6d7a45dSGunnar Mills        <Property Name="Actions" Type="AutomationInstrumentation.v1_0_0.Actions" Nullable="false">
108*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The available actions for this resource."/>
109*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
110*c6d7a45dSGunnar Mills        </Property>
111*c6d7a45dSGunnar Mills      </EntityType>
112*c6d7a45dSGunnar Mills
113*c6d7a45dSGunnar Mills      <ComplexType Name="Actions">
114*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
115*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The available actions for this resource."/>
116*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
117*c6d7a45dSGunnar Mills        <Property Name="Oem" Type="AutomationInstrumentation.v1_0_0.OemActions" Nullable="false">
118*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
119*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
120*c6d7a45dSGunnar Mills        </Property>
121*c6d7a45dSGunnar Mills      </ComplexType>
122*c6d7a45dSGunnar Mills
123*c6d7a45dSGunnar Mills      <ComplexType Name="OemActions">
124*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
125*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
126*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
127*c6d7a45dSGunnar Mills      </ComplexType>
128*c6d7a45dSGunnar Mills    </Schema>
129*c6d7a45dSGunnar Mills
130*c6d7a45dSGunnar Mills  </edmx:DataServices>
131*c6d7a45dSGunnar Mills</edmx:Edmx>
132