xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/AutomationInstrumentation_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################       -->
4<!--# Redfish Schema:  AutomationInstrumentation v1.0.0                                    -->
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-2025 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:Reference>
23  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24    <edmx:Include Namespace="Resource"/>
25    <edmx:Include Namespace="Resource.v1_0_0"/>
26  </edmx:Reference>
27  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
28    <edmx:Include Namespace="Sensor"/>
29  </edmx:Reference>
30  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Control_v1.xml">
31    <edmx:Include Namespace="Control"/>
32  </edmx:Reference>
33  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/AutomationNode_v1.xml">
34    <edmx:Include Namespace="AutomationNode"/>
35  </edmx:Reference>
36
37  <edmx:DataServices>
38
39    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AutomationInstrumentation">
40      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41
42      <EntityType Name="AutomationInstrumentation" BaseType="Resource.v1_0_0.Resource" Abstract="true">
43        <Annotation Term="OData.Description" String="The `AutomationInstrumentation` schema contains measurements and set points for an automation node."/>
44        <Annotation Term="OData.LongDescription" String="This resource shall represent automation node instrumentation for a Redfish implementation."/>
45        <Annotation Term="Capabilities.InsertRestrictions">
46          <Record>
47            <PropertyValue Property="Insertable" Bool="false"/>
48          </Record>
49        </Annotation>
50        <Annotation Term="Capabilities.UpdateRestrictions">
51          <Record>
52            <PropertyValue Property="Updatable" Bool="true"/>
53          </Record>
54        </Annotation>
55        <Annotation Term="Capabilities.DeleteRestrictions">
56          <Record>
57            <PropertyValue Property="Deletable" Bool="false"/>
58          </Record>
59        </Annotation>
60        <Annotation Term="Redfish.Uris">
61          <Collection>
62            <String>/redfish/v1/AutomationNodes/{AutomationNodeId}/AutomationInstrumentation</String>
63          </Collection>
64        </Annotation>
65      </EntityType>
66    </Schema>
67
68    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AutomationInstrumentation.v1_0_0">
69      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
70      <Annotation Term="Redfish.Release" String="2025.2"/>
71
72      <EntityType Name="AutomationInstrumentation" BaseType="AutomationInstrumentation.AutomationInstrumentation">
73        <Property Name="NodeState" Type="AutomationNode.NodeState" Nullable="false">
74          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
75          <Annotation Term="OData.Description" String="The current state of the node."/>
76          <Annotation Term="OData.LongDescription" String="This parameter shall specify the current state of the automation node."/>
77        </Property>
78        <Property Name="Status" Type="Resource.Status" Nullable="false">
79          <Annotation Term="OData.Description" String="The status and health of a resource and its children."/>
80          <Annotation Term="OData.LongDescription" String="This type shall contain any status or health properties of a resource."/>
81        </Property>
82        <NavigationProperty Name="PID" Type="Control.Control">
83          <Annotation Term="Redfish.ExcerptCopy" String="SingleLoop"/>
84          <Annotation Term="OData.Description" String="A PID control loop."/>
85          <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        </NavigationProperty>
87        <NavigationProperty Name="NodeControl" Type="Control.Control">
88          <Annotation Term="Redfish.ExcerptCopy" String="Node"/>
89          <Annotation Term="OData.Description" String="The control for this node."/>
90          <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        </NavigationProperty>
92        <NavigationProperty Name="TemperatureCelsius" Type="Sensor.Sensor">
93          <Annotation Term="Redfish.ExcerptCopy"/>
94          <Annotation Term="OData.Description" String="Temperature (Celsius)."/>
95          <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        </NavigationProperty>
97        <NavigationProperty Name="Voltage" Type="Sensor.Sensor">
98          <Annotation Term="Redfish.ExcerptCopy" String="Voltage"/>
99          <Annotation Term="OData.Description" String="The voltage (V) for this node."/>
100          <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        </NavigationProperty>
102        <NavigationProperty Name="CurrentAmps" Type="Sensor.Sensor">
103          <Annotation Term="Redfish.ExcerptCopy" String="Current"/>
104          <Annotation Term="OData.Description" String="The current (A) for this node."/>
105          <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        </NavigationProperty>
107        <Property Name="Actions" Type="AutomationInstrumentation.v1_0_0.Actions" Nullable="false">
108          <Annotation Term="OData.Description" String="The available actions for this resource."/>
109          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
110        </Property>
111      </EntityType>
112
113      <ComplexType Name="Actions">
114        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
115        <Annotation Term="OData.Description" String="The available actions for this resource."/>
116        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
117        <Property Name="Oem" Type="AutomationInstrumentation.v1_0_0.OemActions" Nullable="false">
118          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
119          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
120        </Property>
121      </ComplexType>
122
123      <ComplexType Name="OemActions">
124        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
125        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
126        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
127      </ComplexType>
128    </Schema>
129
130  </edmx:DataServices>
131</edmx:Edmx>
132