1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/Sensor.v1_1_1.json",
"$ref": "#/definitions/Sensor",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#Sensor.ResetMetrics": {
"$ref": "#/definitions/ResetMetrics"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this resource."
}
},
"type": "object"
},
"ImplementationType": {
"enum": [
"PhysicalSensor",
"Synthesized",
"Reported"
],
"enumDescriptions": {
"PhysicalSensor": "The reading is acquired from a physical sensor.",
"Reported": "The reading is obtained from software or a device.",
"Synthesized": "The reading is obtained by applying a calculation on one or more properties. The calculation is not provided."
},
"type": "string"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"ReadingType": {
"enum": [
"Temperature",
"Humidity",
"Power",
"EnergykWh",
"EnergyJoules",
"Voltage",
"Current",
"Frequency",
"Pressure",
"LiquidLevel",
"Rotational",
"AirFlow",
"LiquidFlow",
"Barometric",
"Altitude",
"Percent"
],
"enumDescriptions": {
"AirFlow": "Airflow.",
"Altitude": "Altitude.",
"Barometric": "Barometric pressure.",
"Current": "Current.",
"EnergyJoules": "Energy (Joules).",
"EnergykWh": "Energy (kWh).",
"Frequency": "Frequency.",
"Humidity": "Relative Humidity.",
"LiquidFlow": "Liquid flow.",
"LiquidLevel": "Liquid level.",
"Percent": "Percent.",
"Power": "Power.",
"Pressure": "Pressure.",
"Rotational": "Rotational.",
"Temperature": "Temperature.",
"Voltage": "Voltage (AC or DC)."
},
"enumLongDescriptions": {
"AirFlow": "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`.",
"Altitude": "This value shall indicate a measurement of altitude, in meter units, and the ReadingUnits value shall be `m`.",
"Barometric": "This value shall indicate a measurement of barometric pressure, in millimeters, of a mercury column, and the ReadingUnits value shall be `mm[Hg]`.",
"Current": "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`.",
"EnergyJoules": "This value shall indicate the energy, integral of real power over time, of the monitored item since the sensor metrics 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.",
"EnergykWh": "This value shall indicate the energy, integral of real power over time, of the monitored item since the sensor metrics 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.",
"Frequency": "This value shall indicate a frequency measurement, in Hertz units, and the ReadingUnits value shall be `Hz`.",
"Humidity": "This value shall indicate a relative humidity measurement, in percent units, and the ReadingUnits value shall be '%'.",
"LiquidFlow": "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`.",
"LiquidLevel": "This value shall indicate a measurement of fluid height relative to a specified vertical datum and the ReadingUnits value shall be `cm`.",
"Percent": "This value shall indicate a percentage measurement, in percent units, and the ReadingUnits value shall be `%`.",
"Power": "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'.",
"Pressure": "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`.",
"Rotational": "This value shall indicate a measurement of rotational frequency, in revolutions per minute unit, and the ReadingUnits value shall be `RPM`.",
"Temperature": "This value shall indicate a temperature measurement, in degrees Celsius units, and the ReadingUnits value shall be 'Cel'.",
"Voltage": "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`."
},
"enumVersionAdded": {
"Percent": "v1_1_0"
},
"type": "string"
},
"ResetMetrics": {
"additionalProperties": false,
"description": "Resets metrics related to this sensor.",
"longDescription": "This action shall reset any time intervals or counted values for this sensor. The SensorResetTime property shall be updated to reflect the time that this action was performed.",
"parameters": {},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
},
"Sensor": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Accuracy": {
"description": "The estimated percent error of measured versus actual values.",
"longDescription": "This property shall contain the percent error +/- of the measured versus actual values of the Reading property.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "%"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "This property shall contain the available actions for this resource."
},
"AdjustedMaxAllowableOperatingValue": {
"description": "The adjusted maximum allowable operating value for this equipment based on the environmental conditions.",
"longDescription": "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 can be adjusted based on the available liquid pressure.",
"readonly": true,
"type": [
"number",
"null"
]
},
"AdjustedMinAllowableOperatingValue": {
"description": "The adjusted minimum allowable operating value for this equipment based on the environmental conditions.",
"longDescription": "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 can be adjusted based on the available liquid pressure.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ApparentVA": {
"description": "The product of voltage and current for an AC circuit, in Volt-Ampere units.",
"excerpt": "SensorPower",
"longDescription": "This property shall contain the product of VoltageRMS multiplied by CurrentRMS for a circuit. This property can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "V.A"
},
"CrestFactor": {
"description": "The crest factor for this sensor.",
"excerpt": "SensorCurrent,SensorVoltage",
"longDescription": "This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"ElectricalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/ElectricalContext"
},
{
"type": "null"
}
],
"description": "The combination of current-carrying conductors.",
"longDescription": "This property shall represent the combination of current-carrying conductors that distribute power.",
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Implementation": {
"anyOf": [
{
"$ref": "#/definitions/ImplementationType"
},
{
"type": "null"
}
],
"description": "The implementation of the sensor.",
"longDescription": "This property shall contain the implementation of the sensor.",
"readonly": true,
"versionAdded": "v1_1_0"
},
"LifetimeReading": {
"description": "The total accumulation value for this sensor.",
"excerpt": "SensorEnergykWh",
"longDescription": "This property shall contain the total accumulation of the Reading property over the sensor's life time. This value shall not be reset by the ResetStatistics action.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"LoadPercent": {
"deprecated": "This property has been deprecated in favor of using a sensor instance with a ReadingType of `Percent` to show utilization values when needed.",
"description": "The power load utilization for this sensor.",
"longDescription": "This property shall indicate the power load utilization percent for this sensor. This property can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "%",
"versionDeprecated": "v1_1_0"
},
"Location": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
"description": "The location information for this sensor.",
"longDescription": "This property shall indicate the location information for this sensor."
},
"MaxAllowableOperatingValue": {
"description": "The maximum allowable operating value for this equipment.",
"longDescription": "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.",
"readonly": true,
"type": [
"number",
"null"
]
},
"MinAllowableOperatingValue": {
"description": "The minimum allowable operating value for this equipment.",
"longDescription": "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.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"PeakReading": {
"description": "The peak sensor value.",
"longDescription": "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.",
"readonly": true,
"type": [
"number",
"null"
]
},
"PeakReadingTime": {
"description": "The time when the peak sensor value occurred.",
"format": "date-time",
"longDescription": "This property shall contain the date and time when the peak sensor value was observed.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PhysicalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext"
},
{
"type": "null"
}
],
"description": "The area or device to which this sensor measurement applies.",
"excerpt": "SensorArray",
"longDescription": "This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies.",
"readonly": true
},
"PhysicalSubContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalSubContext"
},
{
"type": "null"
}
],
"description": "The usage or location within a device to which this sensor measurement applies.",
"excerpt": "SensorArray",
"longDescription": "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.",
"readonly": true
},
"PowerFactor": {
"description": "The power factor for this sensor.",
"excerpt": "SensorPower",
"longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"maximum": 1,
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
]
},
"Precision": {
"description": "The number of significant digits in the reading.",
"longDescription": "This property shall contain the number of significant digits in the Reading property.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReactiveVAR": {
"description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units.",
"excerpt": "SensorPower",
"longDescription": "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 can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "V.A"
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingRangeMax": {
"description": "The maximum possible value for this sensor.",
"longDescription": "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.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingRangeMin": {
"description": "The minimum possible value for this sensor.",
"longDescription": "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.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingTime": {
"description": "The date and time that the reading was acquired from the sensor.",
"format": "date-time",
"longDescription": "This property shall contain the date and timetime that the reading data was acquired from the sensor. This value is used to synchronize readings from multiple sensors, and does not represent the time at which the resource was accessed.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
},
"ReadingType": {
"anyOf": [
{
"$ref": "#/definitions/ReadingType"
},
{
"type": "null"
}
],
"description": "The type of sensor.",
"longDescription": "This property shall contain the type of the sensor.",
"readonly": true
},
"ReadingUnits": {
"description": "The units of the reading and thresholds.",
"longDescription": "This property shall contain the units of the sensor's reading and thresholds.",
"readonly": true,
"type": [
"string",
"null"
]
},
"SensingFrequency": {
"deprecated": "This property has been deprecated in favor of the SensingInterval property, which uses the duration time format for interoperability.",
"description": "The time interval between readings of the physical sensor.",
"longDescription": "This property shall contain the time interval between readings of the physical sensor.",
"readonly": true,
"type": [
"number",
"null"
],
"versionDeprecated": "v1_1_0"
},
"SensingInterval": {
"description": "The time interval between readings of the sensor.",
"longDescription": "This property shall contain the time interval between readings of data from the sensor.",
"pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
},
"SensorResetTime": {
"description": "The date and time when the time-based properties were last reset.",
"excerpt": "SensorEnergykWh",
"format": "date-time",
"longDescription": "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.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the resource and its subordinate or dependent resources.",
"longDescription": "This property shall contain any status or health properties of the resource."
},
"THDPercent": {
"description": "The total harmonic distortion (THD).",
"excerpt": "SensorCurrent,SensorVoltage",
"longDescription": "This property shall contain the total harmonic distortion of the Reading property in percent units.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"Thresholds": {
"$ref": "#/definitions/Thresholds",
"description": "The set of thresholds defined for this sensor.",
"longDescription": "This property shall contain the set of thresholds that derive a sensor's health and operational range."
},
"VoltageType": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/VoltageType"
},
{
"type": "null"
}
],
"description": "The voltage type for this sensor.",
"longDescription": "This property shall represent the type of input voltage the sensor monitors.",
"readonly": true
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"SensorArrayExcerpt": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"excerpt": "SensorArray",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"DataSourceUri": {
"description": "The link to the resource that provides the data for this sensor.",
"excerptCopyOnly": true,
"format": "uri-reference",
"longDescription": "This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PhysicalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext"
},
{
"type": "null"
}
],
"description": "The area or device to which this sensor measurement applies.",
"excerpt": "SensorArray",
"longDescription": "This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies.",
"readonly": true
},
"PhysicalSubContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalSubContext"
},
{
"type": "null"
}
],
"description": "The usage or location within a device to which this sensor measurement applies.",
"excerpt": "SensorArray",
"longDescription": "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.",
"readonly": true
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"SensorCurrentExcerpt": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"excerpt": "SensorCurrent",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"CrestFactor": {
"description": "The crest factor for this sensor.",
"excerpt": "SensorCurrent,SensorVoltage",
"longDescription": "This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"DataSourceUri": {
"description": "The link to the resource that provides the data for this sensor.",
"excerptCopyOnly": true,
"format": "uri-reference",
"longDescription": "This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
},
"THDPercent": {
"description": "The total harmonic distortion (THD).",
"excerpt": "SensorCurrent,SensorVoltage",
"longDescription": "This property shall contain the total harmonic distortion of the Reading property in percent units.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"SensorEnergykWhExcerpt": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"excerpt": "SensorEnergykWh",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"DataSourceUri": {
"description": "The link to the resource that provides the data for this sensor.",
"excerptCopyOnly": true,
"format": "uri-reference",
"longDescription": "This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"LifetimeReading": {
"description": "The total accumulation value for this sensor.",
"excerpt": "SensorEnergykWh",
"longDescription": "This property shall contain the total accumulation of the Reading property over the sensor's life time. This value shall not be reset by the ResetStatistics action.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
},
"SensorResetTime": {
"description": "The date and time when the time-based properties were last reset.",
"excerpt": "SensorEnergykWh",
"format": "date-time",
"longDescription": "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.",
"readonly": true,
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"SensorExcerpt": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"excerpt": "Sensor",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"DataSourceUri": {
"description": "The link to the resource that provides the data for this sensor.",
"excerptCopyOnly": true,
"format": "uri-reference",
"longDescription": "This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"SensorPowerExcerpt": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"excerpt": "SensorPower",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"ApparentVA": {
"description": "The product of voltage and current for an AC circuit, in Volt-Ampere units.",
"excerpt": "SensorPower",
"longDescription": "This property shall contain the product of VoltageRMS multiplied by CurrentRMS for a circuit. This property can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "V.A"
},
"DataSourceUri": {
"description": "The link to the resource that provides the data for this sensor.",
"excerptCopyOnly": true,
"format": "uri-reference",
"longDescription": "This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PowerFactor": {
"description": "The power factor for this sensor.",
"excerpt": "SensorPower",
"longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"maximum": 1,
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
]
},
"ReactiveVAR": {
"description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units.",
"excerpt": "SensorPower",
"longDescription": "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 can appear in sensors of the Power ReadingType, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "V.A"
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"SensorVoltageExcerpt": {
"additionalProperties": false,
"description": "The Sensor schema describes a sensor and its properties.",
"excerpt": "SensorVoltage",
"longDescription": "This resource shall represent a sensor for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"CrestFactor": {
"description": "The crest factor for this sensor.",
"excerpt": "SensorCurrent,SensorVoltage",
"longDescription": "This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"DataSourceUri": {
"description": "The link to the resource that provides the data for this sensor.",
"excerptCopyOnly": true,
"format": "uri-reference",
"longDescription": "This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Reading": {
"description": "The sensor value.",
"excerpt": "Sensor",
"longDescription": "This property shall contain the sensor value.",
"readonly": true,
"type": [
"number",
"null"
]
},
"THDPercent": {
"description": "The total harmonic distortion (THD).",
"excerpt": "SensorCurrent,SensorVoltage",
"longDescription": "This property shall contain the total harmonic distortion of the Reading property in percent units.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"Threshold": {
"additionalProperties": false,
"description": "The threshold definition for a sensor.",
"longDescription": "This type shall contain the properties for an individual threshold for this sensor.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Activation": {
"anyOf": [
{
"$ref": "#/definitions/ThresholdActivation"
},
{
"type": "null"
}
],
"description": "The direction of crossing that activates this threshold.",
"longDescription": "This property shall indicate the direction of crossing of the reading for this sensor that activates the threshold.",
"readonly": false
},
"DwellTime": {
"description": "The duration the sensor value must violate the threshold before the threshold is activated.",
"longDescription": "This property shall indicate the duration the sensor value must violate the threshold before the threshold is activated.",
"pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
"readonly": false,
"type": [
"string",
"null"
]
},
"Reading": {
"description": "The threshold value.",
"longDescription": "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.",
"readonly": false,
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"ThresholdActivation": {
"enum": [
"Increasing",
"Decreasing",
"Either"
],
"enumDescriptions": {
"Decreasing": "Value decreases below the threshold.",
"Either": "Value crosses the threshold in either direction.",
"Increasing": "Value increases above the threshold."
},
"enumLongDescriptions": {
"Decreasing": "This threshold is activated when the reading changes from a value higher than the threshold to a value lower than the threshold.",
"Either": "This threshold is activated when either the increasing or decreasing conditions are met.",
"Increasing": "This threshold is activated when the reading changes from a value lower than the threshold to a value higher than the threshold."
},
"type": "string"
},
"Thresholds": {
"additionalProperties": false,
"description": "The set of thresholds defined for a sensor.",
"longDescription": "This object shall contain the set of thresholds that derive a sensor's health and operational range.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"LowerCaution": {
"$ref": "#/definitions/Threshold",
"description": "The value at which the reading is below normal range.",
"longDescription": "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."
},
"LowerCritical": {
"$ref": "#/definitions/Threshold",
"description": "The value at which the reading is below normal range but not yet fatal.",
"longDescription": "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."
},
"LowerFatal": {
"$ref": "#/definitions/Threshold",
"description": "The value at which the reading is below normal range and fatal.",
"longDescription": "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."
},
"UpperCaution": {
"$ref": "#/definitions/Threshold",
"description": "The value at which the reading is above normal range.",
"longDescription": "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."
},
"UpperCritical": {
"$ref": "#/definitions/Threshold",
"description": "The value at which the reading is above normal range but not yet fatal.",
"longDescription": "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."
},
"UpperFatal": {
"$ref": "#/definitions/Threshold",
"description": "The value at which the reading is above normal range and fatal.",
"longDescription": "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."
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2019.4",
"title": "#Sensor.v1_1_1.Sensor"
}
|
