FDO2 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
fdo2::Status Struct Reference

The status word S of #MOXY and #MRAW, decoded (datasheet 4.3, #MOXY). Pure functions of the word; the word is kept whole. More...

#include <fdo2_types.hpp>

Public Member Functions

constexpr bool AmplificationReduced () const noexcept
 
constexpr bool SignalTooLow () const noexcept
 
constexpr bool SignalTooHigh () const noexcept
 
constexpr bool ReferenceTooLow () const noexcept
 
constexpr bool ReferenceTooHigh () const noexcept
 
constexpr bool TemperatureSensorFailed () const noexcept
 
constexpr bool HumidityHigh () const noexcept
 
constexpr bool PressureSensorFailed () const noexcept
 
constexpr bool HumiditySensorFailed () const noexcept
 
constexpr bool AnyFatal () const noexcept
 
constexpr bool UndefinedBits () const noexcept
 
constexpr Quality Classify () const noexcept
 

Public Attributes

uint32_t word {0}
 The unsigned 32 bit status word as the module sent it.
 

Detailed Description

The status word S of #MOXY and #MRAW, decoded (datasheet 4.3, #MOXY). Pure functions of the word; the word is kept whole.

Member Function Documentation

◆ AmplificationReduced()

constexpr bool fdo2::Status::AmplificationReduced ( ) const
inlineconstexprnoexcept
Returns
Bit 0: WARNING, detector amplification reduced; the reading is valid.

◆ AnyFatal()

constexpr bool fdo2::Status::AnyFatal ( ) const
inlineconstexprnoexcept
Returns
Any of the FATAL bits 1 to 5.

◆ Classify()

constexpr Quality fdo2::Status::Classify ( ) const
inlineconstexprnoexcept
Returns
The quality class of the word (see Quality).

◆ HumidityHigh()

constexpr bool fdo2::Status::HumidityHigh ( ) const
inlineconstexprnoexcept
Returns
Bit 7: WARNING, humidity inside the housing above 90 RH.

◆ HumiditySensorFailed()

constexpr bool fdo2::Status::HumiditySensorFailed ( ) const
inlineconstexprnoexcept
Returns
Bit 10: ERROR, humidity sensor failure; the pO2 is not affected.

◆ PressureSensorFailed()

constexpr bool fdo2::Status::PressureSensorFailed ( ) const
inlineconstexprnoexcept
Returns
Bit 9: ERROR, pressure sensor failure; the pO2 is not affected.

◆ ReferenceTooHigh()

constexpr bool fdo2::Status::ReferenceTooHigh ( ) const
inlineconstexprnoexcept
Returns
Bit 4: FATAL, reference signal or ambient light too high (above 2400 mV).

◆ ReferenceTooLow()

constexpr bool fdo2::Status::ReferenceTooLow ( ) const
inlineconstexprnoexcept
Returns
Bit 3: FATAL, reference signal intensity too low (below 20 mV).

◆ SignalTooHigh()

constexpr bool fdo2::Status::SignalTooHigh ( ) const
inlineconstexprnoexcept
Returns
Bit 2: FATAL, oxygen signal or ambient light too high.

◆ SignalTooLow()

constexpr bool fdo2::Status::SignalTooLow ( ) const
inlineconstexprnoexcept
Returns
Bit 1: FATAL, oxygen signal intensity too low (below 20 mV).

◆ TemperatureSensorFailed()

constexpr bool fdo2::Status::TemperatureSensorFailed ( ) const
inlineconstexprnoexcept
Returns
Bit 5: FATAL, temperature sensor failure.

◆ UndefinedBits()

constexpr bool fdo2::Status::UndefinedBits ( ) const
inlineconstexprnoexcept
Returns
Any bit the datasheet does not define: 6, 8 and 11 to 31.

The documentation for this struct was generated from the following file: