xref: /openbmc/bmcweb/features/redfish/include/registries/sensor_event_message_registry.hpp (revision 56b81992ba8a8e644f2e75251a94df4f4d0d0880) 
1 #pragma once
2 /****************************************************************
3  *                 READ THIS WARNING FIRST
4  * This is an auto-generated header which contains definitions
5  * for Redfish DMTF defined messages.
6  * DO NOT modify this registry outside of running the
7  * parse_registries.py script.  The definitions contained within
8  * this file are owned by DMTF.  Any modifications to these files
9  * should be first pushed to the relevant registry in the DMTF
10  * github organization.
11  ***************************************************************/
12 #include "registries.hpp"
13 
14 #include <array>
15 
16 // clang-format off
17 
18 namespace redfish::registries::sensor_event
19 {
20 const Header header = {
21     "Copyright 2022-2023 DMTF. All rights reserved.",
22     "#MessageRegistry.v1_6_2.MessageRegistry",
23     1,
24     0,
25     1,
26     "Sensor Event Message Registry",
27     "en",
28     "This registry defines messages used for general events related to Sensor resources.",
29     "SensorEvent",
30     "DMTF",
31 };
32 constexpr const char* url =
33     "https://redfish.dmtf.org/registries/SensorEvent.1.0.1.json";
34 
35 constexpr std::array registry =
36 {
37     MessageEntry{
38         "InvalidSensorReading",
39         {
40             "Indicates that the service received an invalid reading from a sensor.",
41             "Invalid reading received from sensor '%1'.",
42             "Warning",
43             1,
44             {
45                 "string",
46             },
47             "Check the sensor hardware or connection.",
48         }},
49     MessageEntry{
50         "ReadingAboveLowerCriticalThreshold",
51         {
52             "Indicates that a sensor reading is no longer below the lower critical threshold but is still outside of normal operating range.",
53             "Sensor '%1' reading of %2 (%3) is now above the %4 lower critical threshold but remains outside of normal range.",
54             "Warning",
55             4,
56             {
57                 "string",
58                 "number",
59                 "string",
60                 "number",
61             },
62             "Check the condition of the resources listed in RelatedItem.",
63         }},
64     MessageEntry{
65         "ReadingAboveLowerFatalThreshold",
66         {
67             "Indicates that a sensor reading is no longer below the lower fatal threshold but is still outside of normal operating range.",
68             "Sensor '%1' reading of %2 (%3) is now above the %4 lower fatal threshold but remains outside of normal range.",
69             "Critical",
70             4,
71             {
72                 "string",
73                 "number",
74                 "string",
75                 "number",
76             },
77             "Check the condition of the resources listed in RelatedItem.",
78         }},
79     MessageEntry{
80         "ReadingAboveUpperCautionThreshold",
81         {
82             "Indicates that a sensor reading is above the upper caution threshold.",
83             "Sensor '%1' reading of %2 (%3) is above the %4 upper caution threshold.",
84             "Warning",
85             4,
86             {
87                 "string",
88                 "number",
89                 "string",
90                 "number",
91             },
92             "Check the condition of the resources listed in RelatedItem.",
93         }},
94     MessageEntry{
95         "ReadingAboveUpperCriticalThreshold",
96         {
97             "Indicates that a sensor reading is above the upper critical threshold.",
98             "Sensor '%1' reading of %2 (%3) is above the %4 upper critical threshold.",
99             "Critical",
100             4,
101             {
102                 "string",
103                 "number",
104                 "string",
105                 "number",
106             },
107             "Check the condition of the resources listed in RelatedItem.",
108         }},
109     MessageEntry{
110         "ReadingAboveUpperFatalThreshold",
111         {
112             "Indicates that a sensor reading is above the upper fatal threshold.",
113             "Sensor '%1' reading of %2 (%3) is above the %4 upper fatal threshold.",
114             "Critical",
115             4,
116             {
117                 "string",
118                 "number",
119                 "string",
120                 "number",
121             },
122             "Check the condition of the resources listed in RelatedItem.",
123         }},
124     MessageEntry{
125         "ReadingBelowLowerCautionThreshold",
126         {
127             "Indicates that a sensor reading is below the lower caution threshold.",
128             "Sensor '%1' reading of %2 (%3) is below the %4 lower caution threshold.",
129             "Warning",
130             4,
131             {
132                 "string",
133                 "number",
134                 "string",
135                 "number",
136             },
137             "Check the condition of the resources listed in RelatedItem.",
138         }},
139     MessageEntry{
140         "ReadingBelowLowerCriticalThreshold",
141         {
142             "Indicates that a sensor reading is below the lower critical threshold.",
143             "Sensor '%1' reading of %2 (%3) is below the %4 lower critical threshold.",
144             "Critical",
145             4,
146             {
147                 "string",
148                 "number",
149                 "string",
150                 "number",
151             },
152             "Check the condition of the resources listed in RelatedItem.",
153         }},
154     MessageEntry{
155         "ReadingBelowLowerFatalThreshold",
156         {
157             "Indicates that a sensor reading is below the lower fatal threshold.",
158             "Sensor '%1' reading of %2 (%3) is below the %4 lower fatal threshold.",
159             "Critical",
160             4,
161             {
162                 "string",
163                 "number",
164                 "string",
165                 "number",
166             },
167             "Check the condition of the resources listed in RelatedItem.",
168         }},
169     MessageEntry{
170         "ReadingBelowUpperCriticalThreshold",
171         {
172             "Indicates that a sensor reading is no longer above the upper critical threshold but is still outside of normal operating range.",
173             "Sensor '%1' reading of %2 (%3) is now below the %4 upper critical threshold but remains outside of normal range.",
174             "Warning",
175             4,
176             {
177                 "string",
178                 "number",
179                 "string",
180                 "number",
181             },
182             "Check the condition of the resources listed in RelatedItem.",
183         }},
184     MessageEntry{
185         "ReadingBelowUpperFatalThreshold",
186         {
187             "Indicates that a sensor reading is no longer above the upper fatal threshold but is still outside of normal operating range.",
188             "Sensor '%1' reading of %2 (%3) is now below the %4 upper fatal threshold but remains outside of normal range.",
189             "Critical",
190             4,
191             {
192                 "string",
193                 "number",
194                 "string",
195                 "number",
196             },
197             "Check the condition of the resources listed in RelatedItem.",
198         }},
199     MessageEntry{
200         "ReadingCritical",
201         {
202             "Indicates that a sensor reading exceeds an internal critical level.",
203             "Sensor '%1' reading of %2 (%3) exceeds the critical level.",
204             "Critical",
205             3,
206             {
207                 "string",
208                 "number",
209                 "string",
210             },
211             "Check the condition of the resources listed in RelatedItem.",
212         }},
213     MessageEntry{
214         "ReadingNoLongerCritical",
215         {
216             "Indicates that a sensor reading no longer exceeds an internal critical level but still exceeds an internal warning level.",
217             "Sensor '%1' reading of %2 (%3) no longer exceeds the critical level.",
218             "Warning",
219             3,
220             {
221                 "string",
222                 "number",
223                 "string",
224             },
225             "Check the condition of the resources listed in RelatedItem.",
226         }},
227     MessageEntry{
228         "ReadingWarning",
229         {
230             "Indicates that a sensor reading exceeds an internal warning level.",
231             "Sensor '%1' reading of %2 (%3) exceeds the warning level.",
232             "Warning",
233             3,
234             {
235                 "string",
236                 "number",
237                 "string",
238             },
239             "Check the condition of the resources listed in RelatedItem.",
240         }},
241     MessageEntry{
242         "SensorFailure",
243         {
244             "Indicates that the service cannot communicate with a sensor or has detected a failure.",
245             "Sensor '%1' has failed.",
246             "Warning",
247             1,
248             {
249                 "string",
250             },
251             "Check the sensor hardware or connection.",
252         }},
253     MessageEntry{
254         "SensorReadingNormalRange",
255         {
256             "Indicates that a sensor reading is now within normal operating range.",
257             "Sensor '%1' reading of %2 (%3) is within normal operating range.",
258             "OK",
259             3,
260             {
261                 "string",
262                 "number",
263                 "string",
264             },
265             "None.",
266         }},
267     MessageEntry{
268         "SensorRestored",
269         {
270             "Indicates that a sensor was repaired or communications were restored.  It may also indicate that the service is receiving valid data from a sensor.",
271             "Sensor '%1' was restored.",
272             "OK",
273             1,
274             {
275                 "string",
276             },
277             "None.",
278         }},
279 
280 };
281 
282 enum class Index
283 {
284     invalidSensorReading = 0,
285     readingAboveLowerCriticalThreshold = 1,
286     readingAboveLowerFatalThreshold = 2,
287     readingAboveUpperCautionThreshold = 3,
288     readingAboveUpperCriticalThreshold = 4,
289     readingAboveUpperFatalThreshold = 5,
290     readingBelowLowerCautionThreshold = 6,
291     readingBelowLowerCriticalThreshold = 7,
292     readingBelowLowerFatalThreshold = 8,
293     readingBelowUpperCriticalThreshold = 9,
294     readingBelowUpperFatalThreshold = 10,
295     readingCritical = 11,
296     readingNoLongerCritical = 12,
297     readingWarning = 13,
298     sensorFailure = 14,
299     sensorReadingNormalRange = 15,
300     sensorRestored = 16,
301 };
302 } // namespace redfish::registries::sensor_event
303