Class XENSIV_PAS_GASA2LIno

Inheritance Relationships

Base Type

Class Documentation

class XENSIV_PAS_GASA2LIno : public XENSIV_PAS_GASIno

Public Functions

inline XENSIV_PAS_GASA2LIno(TwoWire *wire = &Wire, uint8_t intPin = unusedPin)
inline XENSIV_PAS_GASA2LIno(HardwareSerial *serial, uint8_t intPin = unusedPin)
~XENSIV_PAS_GASA2LIno()

Destructor of the XENSIV_PAS_GASA2LIno class.

Error_t getDeviceID(uint8_t &devID)

Gets device product identifier.

Parameters:

devID – [out] Device identifier

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t getAlarmConfig(bool &activeHigh)

Gets the alarm pin configuration.

Parameters:

activeHigh – [out] true for active high, false for active low

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t getABOCCycle(uint8_t &days)

Gets the ABOC cycle in days.

Parameters:

days – [out] ABOC cycle in days (7 to 70 days)

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t setABOCCycle(uint8_t days)

Sets the ABOC cycle in days.

Parameters:

days – [in] ABOC cycle in days (7 to 70 days)

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t setABOCPrefill(uint8_t hours)

Sets the ABOC prefill value (in hours)

Prefills the ABOC flash table to shorten the current ABOC cycle. The value is capped at (ABOC cycle - 1) hours.

Parameters:

hours – [in] Number of hours to prefill (0 to ABOC cycle - 1)

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t getDenoiseConfig(uint8_t &smoothing_factor)

Gets the denoise configuration.

Parameters:

smoothing_factor – [out]

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t setDenoiseConfig(uint8_t smoothing_factor)

Sets the denoise configuration.

Parameters:

smoothing_factor – [in]

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t selfTestErrorClear(bool clear)

Configures the self-test routine.

Parameters:

enable – [in] true to enable, false to disable

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

String getSelfTestStatusString()

Gets a human-readable self-test status string.

Returns:

String describing self-test errors, or “Self-test passed: No errors.”

Pre:

begin()

Error_t getAlarmHysteresis(uint16_t &hysteresis)

Gets the alarm hysteresis value.

Parameters:

alarm_hys – [out] Alarm hysteresis value (0–32767)

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t setAlarmHysteresis(uint16_t hysteresis)

Sets the alarm hysteresis value.

Parameters:

alarm_hys – [in] Alarm hysteresis value (0–32767)

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t getAbsoluteHumidityRef(uint16_t &abs_humidity)

Gets the absolute humidity reference value.

Parameters:

abs_humidity – [out] Absolute humidity reference value

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t setAbsoluteHumidityRef(uint16_t abs_humidity)

Sets the absolute humidity reference value.

Parameters:

abs_humidity – [in] Absolute humidity reference value

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t enableHumidityCompensation(bool enable)

Enables or disables humidity compensation.

Parameters:

enable – [in] true to enable, false to disable

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t isHumidityCompensationEnabled(bool enable)

Checks if humidity compensation is enabled.

Parameters:

enable – [out] true if enabled, false otherwise

Return values:

XENSIV_PAS_GAS_OK – if success

Returns:

XENSIV™ PAS GAS error code

Pre:

begin()

Error_t setGasSelection(xensiv_pas_gas_a2l_gas_selection_t gas)

Sets the gas selection (GAS_SEL field)

Parameters:

gas – [in] Gas to select (enum value)

Returns:

XENSIV™ PAS GAS error code

Error_t getGasSelection(xensiv_pas_gas_a2l_gas_selection_t &gas)

Gets the current gas selection (GAS_SEL field)

Parameters:

gas – [out] Gas selection (enum value)

Returns:

XENSIV™ PAS GAS error code

Error_t getAvailableGases(uint8_t &gas_avail)

Gets the available gases bitmap (GAS_AVAIL field, bits 7:4)

Parameters:

gas_avail – [out] Bitmap of available gases (bits 7:4)

Returns:

XENSIV™ PAS GAS error code