Sensor
Description
This resource shall represent a sensor for a Redfish implementation.
Fields
| Field | Type | Description |
|---|---|---|
AdjustedMaxAllowableOperatingValue | number | 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. |
AdjustedMinAllowableOperatingValue | number | 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. |
ApparentkVAh | number | This property shall contain the apparent energy, in kilovolt-ampere-hour units, for an electrical energy measurement. This property can appear in sensors with a `ReadingType` containing `EnergykWh`, and shall not appear in sensors with other `ReadingType` values. |
ApparentVA | number | This property shall contain the product of voltage (RMS) multiplied by current (RMS) for a circuit. This property can appear in sensors of the `Power` `ReadingType`, and shall not appear in sensors of other `ReadingType` values. |
AverageReading | number | This property shall contain the average sensor value over the time specified by the value of the `AveragingInterval` property. The value shall be reset by the `ResetMetrics` action or by a service reset of time-based property values. |
AveragingInterval | string | This property shall contain the interval over which the sensor value is averaged to produce the value of the `AverageReading` property. This property shall only be present if the `AverageReading` property is present. |
AveragingIntervalAchieved | boolean | This property shall indicate that enough readings were collected to calculate the `AverageReading` value over the interval specified by the `AveragingInterval` property. The value shall be reset by the `ResetMetrics` action. This property shall only be present if the `AveragingInterval` property is present. |
Calibration | number | This property shall contain the offset applied to the raw sensor value to provide a calibrated value for the sensor as returned by the `Reading` property. The value of this property shall follow the units of the `Reading` property for this sensor instance. Updating the value of this property shall not affect the value of the `CalibrationTime` property. |
CalibrationTime | string | This property shall contain the date and time that the sensor was last calibrated. This property is intended to reflect the actual time the calibration occurred. |
CrestFactor | number | 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. |
Description | Description | |
Enabled | boolean | This property shall indicate whether the sensor is enabled and provides a `Reading`. The value `true` shall indicate the sensor is enabled and returns the `Reading` property with a valid value. The value `false` shall indicate the sensor is disabled, shall not return the `Reading` property, and shall not trigger events, logging, or other functionality. This property allows a user to disable a faulty sensor or to otherwise remove it from use. |
Id | Id | |
LifetimeReading | number | This property shall contain the total accumulation of the `Reading` property over the sensor’s lifetime. This value shall not be reset by the `ResetMetrics` action. |
LifetimeStartDateTime | string | This property shall contain the date and time when the sensor started accumulating readings for the `LifetimeReading` property. This might contain the same value as the production date of the device that contains this sensor. |
Links | Links | This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource. |
Location | Location | This property shall indicate the location information for this sensor. |
LowestReading | number | This property shall contain the lowest sensor value since the last `ResetMetrics` action was performed or since the service last reset the time-based property values. |
LowestReadingTime | string | This property shall contain the date and time when the lowest sensor value was observed, as reported as the value of `LowestReading`. |
Manufacturer | string | This property shall contain the name of the organization responsible for producing the sensor. This organization may be the entity from whom the sensor is purchased, but this is not necessarily true. This property is generally used only for replaceable or user-configurable sensors. |
MaxAllowableOperatingValue | number | 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. |
MinAllowableOperatingValue | number | 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. |
Model | string | This property shall contain the name by which the manufacturer generally refers to the sensor. This property is generally used only for replaceable or user-configurable sensors. |
Name | Name | |
Oem | Oem | This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements. |
PartNumber | string | This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the sensor. This property is generally used only for replaceable or user-configurable sensors. |
PeakReading | number | This property shall contain the peak sensor value since the last `ResetMetrics` action was performed or since the service last reset the time-based property values. |
PeakReadingTime | string | This property shall contain the date and time when the peak sensor value was observed, as reported as the value of `PeakReading`. |
PhaseAngleDegrees | number | This property shall contain the phase angle, in degree units, between the current and voltage waveforms for an electrical measurement. This property can appear in sensors with a `ReadingType` containing `Power`, and shall not appear in sensors with other `ReadingType` values. |
PhysicalContext | PhysicalContext | This property shall contain a description of the affected component or region within the equipment to which this sensor measurement applies. |
PhysicalSubContext | PhysicalSubContext | 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. |
PowerFactor | number | This property shall identify the quotient of real power (W) and apparent power (VA) for a circuit. `PowerFactor` is expressed in unit-less 1/100ths. This property can appear in sensors containing a `ReadingType` value of `Power`, and shall not appear in sensors of other `ReadingType` values. |
Precision | number | This property shall contain the number of significant digits in the `Reading` property. |
ReactivekVARh | number | This property shall contain the reactive energy, in kilovolt-ampere-hours (reactive) units, for an electrical energy measurement. This property can appear in sensors with a `ReadingType` containing `EnergykWh`, and shall not appear in sensors with other `ReadingType` values. |
ReactiveVAR | number | 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. |
Reading | number | This property shall contain the sensor value. This property shall not be returned if the `Enabled` property is supported and contains `false`. |
ReadingAccuracy | number | This property shall contain the accuracy of the value of the `Reading` property for this sensor. The value shall be the absolute value of the maximum deviation of the `Reading` from its actual value. The value shall be in units that follow the `ReadingUnits` for this sensor. |
ReadingBasis | ReadingBasisType | This property shall indicate the basis or frame of reference for the value of the `Reading` property. If this property is not present, the value shall be assumed to be `Zero`. |
ReadingRangeMax | number | 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. |
ReadingRangeMin | number | 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. |
ReadingTime | string | This property shall contain the date and time 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. |
ReadingType | ReadingType | This property shall contain the type of the sensor. |
ReadingUnits | string | This property shall contain the units of the sensor’s reading, thresholds, and other reading-related properties. The value shall follow the case-sensitive symbol format defined by the Unified Code for Units of Measure (UCUM), as specified by the ‘Units of measure annotation’ clause of the Redfish Specification. |
RelatedItem | array | This property shall contain an array of links to resources or objects that this sensor services. |
RelatedItem@odata.count | count | |
SensingInterval | string | This property shall contain the time interval between readings of data from the sensor. |
SensorGroup | RedundantGroup | This property shall contain information for a group of sensors that provide input for the value of this sensor’s reading. If this property is present, the `Implementation` property shall contain the value `Synthesized`. The group may be created for redundancy or to improve the accuracy of the reading through multiple sensor inputs. |
SensorResetTime | string | This property shall contain the date and time when the `ResetMetrics` action was last performed or when the service last reset the time-based property values. |
SerialNumber | string | This property shall contain a manufacturer-allocated number that identifies the sensor. This property is generally used only for replaceable or user-configurable sensors. |
SKU | string | This property shall contain the stock-keeping unit number for this sensor. This property is generally used only for replaceable or user-configurable sensors. |
SparePartNumber | string | This property shall contain the spare part number of the sensor. This property is generally used only for replaceable or user-configurable sensors. |
SpeedRPM | number | This property shall contain a reading of the rotational speed of the device in revolutions per minute (RPM) units. |
Status | Status | This property shall contain any status or health properties of the resource. |
THDPercent | number | This property shall contain the total harmonic distortion of the `Reading` property in percent units, typically `0` to `100`. |
Thresholds | Thresholds | This property shall contain the set of thresholds that derive a sensor’s health and operational range. |