Class XENSIV_PAS_GASR290Ino

Inheritance Relationships

Base Type

Class Documentation

class XENSIV_PAS_GASR290Ino : public XENSIV_PAS_GASIno

Public Functions

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

Destructor of the XENSIV_PAS_GASR290Ino 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()