A sensor with numeric readings. More...
import"NumericSensor.idl";
Inheritance diagram for sensors::NumericSensor:
Classes | |
| struct | MetaData |
| Numeric sensor metadata. More... | |
| struct | MinMax |
| Numeric sensor minimum / maximum values. More... | |
| struct | Range |
| Range of possible sensor readings. More... | |
| struct | Reading |
| Numeric sensor reading. More... | |
| struct | ThresholdCapabilities |
| Threshold capabilities. More... | |
| struct | Thresholds |
| Numeric sensor thresholds. More... | |
Public Member Functions | |
| MetaData | getMetaData () |
| Retrieve the sensor metadata. More... | |
| Thresholds | getDefaultThresholds () |
| Retrieve the sensor default thresholds. More... | |
| Thresholds | getThresholds () |
| Retrieve the active thresholds. More... | |
| int | setThresholds (in Thresholds thresh) |
| Change the active thresholds. More... | |
| Reading | getReading () |
| Get the sensor reading. More... | |
| MinMax | getMinMax () |
| Get the min / max of sensor value. More... | |
| void | resetMinMax () |
| Reset min / max of sensor value. | |
 Public Member Functions inherited from sensors::Sensor | |
| TypeSpec | getTypeSpec () |
| Retrieve the sensor type specification. More... | |
| boolean | isTypeChangeAllowed () |
| Check whether the sensor type can be changed using setType(). More... | |
| int | setType (in int type, in int unit) |
| Set sensor type and unit. More... | |
Public Attributes | |
| constant int | THRESHOLD_OUT_OF_RANGE = 1 |
| The threshold exceedes the sensor range. | |
| constant int | THRESHOLD_INVALID = 2 |
| The threshold constraints are not met. | |
| constant int | THRESHOLD_NOT_SUPPORTED = 3 |
| The sensor does not support setting this threshold. | |
| valueobject | ReadingChangedEvent: idl::Event { Reading newReading |
| Event: Numeric sensor reading has changed. More... | |
| valueobject | StateChangedEvent: idl::Event { Reading oldReading |
| Event: Sensor state has changed. More... | |
| Reading | newReading |
| Reading after state change. | |
| valueobject | MetaDataChangedEvent: idl::Event { MetaData oldMetaData |
| Event: Sensor metadata has changed. More... | |
| MetaData | newMetaData |
| Metadata after change. | |
| valueobject | ThresholdsChangedEvent: event::UserEvent { Thresholds oldThresholds |
| Event: Sensor thresholds have changed. More... | |
| Thresholds | newThresholds |
| Threshold set after change. | |
| valueobject | MinMaxChangedEvent: idl::Event { MinMax newMinMax |
| Event: Sensor min or max value has changed. More... | |
| valueobject | MinMaxResetEvent: event::UserEvent { MinMax oldMinMax |
| Event: Min / Max value has been reset. More... | |
| MinMax | newMinMax |
| Min / max after reset, incl. new observedSince timestamp. | |
| Public Attributes inherited from sensors::Sensor | |
| constant int | ERR_NOT_SUPPORTED = 1 |
| The operation is not supported. | |
| constant int | NUMERIC = 0 |
| Sensor reading type | |
| constant int | DISCRETE_ON_OFF = 1 |
| constant int | DISCRETE_MULTI = 2 |
| constant int | UNSPECIFIED = 0 |
| Sensor type | |
| constant int | VOLTAGE = 1 |
| constant int | CURRENT = 2 |
| constant int | UNBALANCE_CURRENT = 3 |
| constant int | POWER = 4 |
| constant int | POWER_FACTOR = 5 |
| constant int | ENERGY = 6 |
| constant int | FREQUENCY = 7 |
| constant int | TEMPERATURE = 8 |
| constant int | HUMIDITY = 9 |
| constant int | AIR_FLOW = 10 |
| constant int | AIR_PRESSURE = 11 |
| constant int | CONTACT_CLOSURE = 12 |
| constant int | ON_OFF_SENSOR = 13 |
| constant int | TRIP_SENSOR = 14 |
| constant int | VIBRATION = 15 |
| constant int | WATER_LEAK = 16 |
| constant int | SMOKE_DETECTOR = 17 |
| constant int | TOTAL_HARMONIC_DISTORTION = 18 |
| constant int | MASS = 19 |
| constant int | ELECTRICAL_RESISTANCE = 20 |
| constant int | FLUX = 21 |
| constant int | LUMINOUS_INTENSITY = 22 |
| constant int | ACCELERATION = 23 |
| constant int | MAGNETIC_FLUX_DENSITY = 24 |
| constant int | ELECTRIC_FIELD_STRENGTH = 25 |
| constant int | MAGNETIC_FIELD_STRENGTH = 26 |
| constant int | ANGLE = 27 |
| constant int | SELECTION = 28 |
| constant int | FAULT_STATE = 29 |
| constant int | POWER_QUALITY = 30 |
| constant int | ROTATIONAL_SPEED = 31 |
| constant int | LUMINOUS_ENERGY = 32 |
| constant int | LUMINOUS_FLUX = 33 |
| constant int | ILLUMINANCE = 34 |
| constant int | LUMINOUS_EMITTANCE = 35 |
| constant int | MOTION = 36 |
| constant int | OCCUPANCY = 37 |
| constant int | TAMPER = 38 |
| constant int | DRY_CONTACT = 39 |
| constant int | POWERED_DRY_CONTACT = 40 |
| constant int | ABSOLUTE_HUMIDITY = 41 |
| constant int | DOOR_STATE = 42 |
| constant int | DOOR_LOCK_STATE = 43 |
| constant int | DOOR_HANDLE_LOCK = 44 |
| constant int | CREST_FACTOR = 45 |
| constant int | DISTANCE = 46 |
| constant int | LENGTH = 47 |
| constant int | UNBALANCE_VOLTAGE = 48 |
| constant int | PARTICLE_DENSITY = 49 |
| constant int | NONE = 0 |
| Sensor unit | |
| constant int | VOLT = 1 |
| constant int | AMPERE = 2 |
| constant int | WATT = 3 |
| constant int | VOLT_AMP = 4 |
| constant int | WATT_HOUR = 5 |
| constant int | VOLT_AMP_HOUR = 6 |
| constant int | DEGREE_CELSIUS = 7 |
| constant int | HZ = 8 |
| constant int | PERCENT = 9 |
| constant int | METER_PER_SEC = 10 |
| constant int | PASCAL = 11 |
| constant int | G = 12 |
| constant int | RPM = 13 |
| constant int | METER = 14 |
| constant int | HOUR = 15 |
| constant int | MINUTE = 16 |
| constant int | SECOND = 17 |
| constant int | VOLT_AMP_REACTIVE = 18 |
| constant int | VOLT_AMP_REACTIVE_HOUR = 19 |
| constant int | GRAM = 20 |
| constant int | OHM = 21 |
| constant int | LITERS_PER_HOUR = 22 |
| constant int | CANDELA = 23 |
| constant int | METER_PER_SQUARE_SEC = 24 |
| constant int | METER_PER_SQARE_SEC = 24 |
| constant int | TESLA = 25 |
| constant int | VOLT_PER_METER = 26 |
| constant int | VOLT_PER_AMPERE = 27 |
| constant int | DEGREE = 28 |
| constant int | DEGREE_FAHRENHEIT = 29 |
| constant int | KELVIN = 30 |
| constant int | JOULE = 31 |
| constant int | COULOMB = 32 |
| constant int | NIT = 33 |
| constant int | LUMEN = 34 |
| constant int | LUMEN_SECOND = 35 |
| constant int | LUX = 36 |
| constant int | PSI = 37 |
| constant int | NEWTON = 38 |
| constant int | FOOT = 39 |
| constant int | FOOT_PER_SEC = 40 |
| constant int | CUBIC_METER = 41 |
| constant int | RADIANT = 42 |
| constant int | STERADIANT = 43 |
| constant int | HENRY = 44 |
| constant int | FARAD = 45 |
| constant int | MOL = 46 |
| constant int | BECQUEREL = 47 |
| constant int | GRAY = 48 |
| constant int | SIEVERT = 49 |
| constant int | G_PER_CUBIC_METER = 50 |
| constant int | UG_PER_CUBIC_METER = 51 |
| valueobject | TypeSpecChangedEvent: idl::Event { TypeSpec oldTypeSpec |
| Event: The type specification of the sensor changed. More... | |
| TypeSpec | newTypeSpec |
| Type specification after change. | |
Additional Inherited Members | |
| Public Types inherited from sensors::Sensor | |
| enum | OnOffState { OFF , ON } |
| Sensor states for DISCRETE_ON_OFF sensors. More... | |
| enum | OpenClosedState { OPEN , CLOSED } |
| enum | NormalAlarmedState { NORMAL , ALARMED } |
| enum | OkFaultState { OK , FAULT } |
Detailed Description
A sensor with numeric readings.
Member Function Documentation
◆ getDefaultThresholds()
| Thresholds sensors::NumericSensor::getDefaultThresholds | ( | ) |
Retrieve the sensor default thresholds.
- Returns
- Set of default thresholds
◆ getMetaData()
| MetaData sensors::NumericSensor::getMetaData | ( | ) |
Retrieve the sensor metadata.
- Returns
- Sensor metadata
◆ getMinMax()
| MinMax sensors::NumericSensor::getMinMax | ( | ) |
Get the min / max of sensor value.
- Returns
- Sensor min / max values
◆ getReading()
| Reading sensors::NumericSensor::getReading | ( | ) |
Get the sensor reading.
- Returns
- Sensor reading, not rounded
◆ getThresholds()
| Thresholds sensors::NumericSensor::getThresholds | ( | ) |
Retrieve the active thresholds.
- Returns
- Set of active thresholds
◆ setThresholds()
| int sensors::NumericSensor::setThresholds | ( | in Thresholds | thresh | ) |
Change the active thresholds.
- Parameters
-
thresh New set of thresholds
- Returns
- 0 if OK
- THRESHOLD_OUT_OF_RANGE if any threshold is out of range
- THRESHOLD_INVALID if thresholds don't meet the requirements
- THRESHOLD_NOT_SUPPORTED if threshold is not supported
Member Data Documentation
◆ MetaDataChangedEvent
| valueobject sensors::NumericSensor::MetaDataChangedEvent |
Event: Sensor metadata has changed.
Metadata before change
◆ MinMaxChangedEvent
| valueobject sensors::NumericSensor::MinMaxChangedEvent |
Event: Sensor min or max value has changed.
The event is sent when MinMax::minReading or MinMax::maxReading have changed enough to affect a digit to be displayed according to MetaData::decdigits, or if MinMax::valid has changed. Minimum / maximum of sensor value
◆ MinMaxResetEvent
| valueobject sensors::NumericSensor::MinMaxResetEvent |
Event: Min / Max value has been reset.
Min / max before reset
◆ ReadingChangedEvent
| valueobject sensors::NumericSensor::ReadingChangedEvent |
Event: Numeric sensor reading has changed.
The event is sent when the Reading::value has changed enough to affect a digit to be displayed according to MetaData::decdigits, or if one of Reading::available, Reading::status or Reading::valid has changed. New numeric sensor reading
◆ StateChangedEvent
| valueobject sensors::NumericSensor::StateChangedEvent |
◆ ThresholdsChangedEvent
| valueobject sensors::NumericSensor::ThresholdsChangedEvent |
Event: Sensor thresholds have changed.
Threshold set before change
The documentation for this interface was generated from the following file:
