SCD40 unit component. More...

#include <unit_SCD40.hpp>

Inheritance diagram for m5::unit::UnitSCD40:

Classes
struct	config_t
	Settings for begin. More...

Public Member Functions
	UnitSCD40 (const uint8_t addr=DEFAULT_ADDRESS)

virtual bool	begin () override

virtual void	update (const bool force=false) override

Settings for begin
config_t	config () const
	Gets the configration.

void	config (const config_t &cfg)
	Set the configration.

Measurement data by periodic
uint16_t	co2 () const
	Oldest measured CO2 concentration (ppm)

float	temperature () const
	Oldest measured temperature (Celsius)

float	celsius () const
	Oldest measured temperature (Celsius)

float	fahrenheit () const
	Oldest measured temperature (Fahrenheit)

float	humidity () const
	Oldest measured humidity (RH)

Periodic measurement
bool	startPeriodicMeasurement (const scd4x::Mode mode=scd4x::Mode::Normal)
	Start periodic measurement.

bool	startLowPowerPeriodicMeasurement ()
	Start low power periodic measurement.

bool	stopPeriodicMeasurement (const uint32_t duration=scd4x::STOP_PERIODIC_MEASUREMENT_DURATION)
	Stop periodic measurement.

On-Chip Output Signal Compensation
bool	writeTemperatureOffset (const float offset, const uint32_t duration=scd4x::SET_TEMPERATURE_OFFSET_DURATION)
	Write the temperature offset.

bool	readTemperatureOffset (float &offset)
	Read the temperature offset.

bool	writeSensorAltitude (const uint16_t altitude, const uint32_t duration=scd4x::SET_SENSOR_ALTITUDE_DURATION)
	Write the sensor altitude.

bool	readSensorAltitude (uint16_t &altitude)
	Read the sensor altitude.

bool	writeAmbientPressure (const uint16_t pressure, const uint32_t duration=scd4x::SET_AMBIENT_PRESSURE_DURATION)
	Write the ambient pressure.

bool	readAmbientPressure (uint16_t &pressure)
	Read the ambient pressure.

Field Calibration
bool	performForcedRecalibration (const uint16_t concentration, int16_t &correction)
	Perform forced recalibration.

bool	writeAutomaticSelfCalibrationEnabled (const bool enabled=true, const uint32_t duration=scd4x::SET_AUTOMATIC_SELF_CALIBRATION_ENABLED_DURATION)
	Enable/disable automatic self calibration.

bool	readAutomaticSelfCalibrationEnabled (bool &enabled)
	Check if automatic self calibration is enabled.

bool	writeAutomaticSelfCalibrationTarget (const uint16_t ppm, const uint32_t duration=scd4x::SET_AUTOMATIC_SELF_CALIBRATION_TARGET_DURATION)
	Write the value of the ASC baseline target.

bool	readAutomaticSelfCalibrationTarget (uint16_t &ppm)
	Read the value of the ASC baseline target.

Advanced Features
bool	writePersistSettings (const uint32_t duration=scd4x::PERSIST_SETTINGS_DURATION)
	Write sensor settings from RAM to EEPROM.

bool	readSerialNumber (char *serialNumber)
	Read the serial number string.

bool	readSerialNumber (uint64_t &serialNumber)
	Read the serial number value.

bool	performSelfTest (bool &malfunction)
	Perform self test.

bool	performFactoryReset (const uint32_t duration=scd4x::PERFORM_FACTORY_RESET_DURATION)
	Peform factory reset.

bool	reInit (const uint32_t duration=scd4x::REINIT_DURATION)
	Re-initialize the sensor, load settings from EEPROM.

Protected Member Functions
bool	read_register (const uint16_t reg, uint8_t *rbuf, const uint32_t rlen, const uint32_t duration=1)

bool	write_register (const uint16_t reg, uint8_t *wbuf, const uint32_t wlen)

bool	start_periodic_measurement (const scd4x::Mode mode=scd4x::Mode::Normal)

bool	stop_periodic_measurement (const uint32_t duration=scd4x::STOP_PERIODIC_MEASUREMENT_DURATION)

bool	read_data_ready_status ()

bool	read_measurement (scd4x::Data &d, const bool all=true)

virtual bool	is_valid_chip ()

bool	delay_true (const uint32_t duration)

	M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitSCD40, scd4x::Data)

Protected Attributes
std::unique_ptr< m5::container::CircularBuffer< scd4x::Data > >	_data {}

config_t	_cfg {}

Detailed Description

SCD40 unit component.

Member Function Documentation

◆ performFactoryReset()

bool m5::unit::UnitSCD40::performFactoryReset ( const uint32_t duration = scd4x::PERFORM_FACTORY_RESET_DURATION )

Peform factory reset.

Reset all settings to the factory values

Returns: True if successful

Warning: During periodic detection runs, an error is returned; Measurement duration max 1200 ms

◆ performForcedRecalibration()

bool m5::unit::UnitSCD40::performForcedRecalibration	(	const uint16_t	concentration,
		int16_t &	correction )

Perform forced recalibration.

Parameters

	concentration	Unit:ppm
[out]	correction	The FRC correction value

Returns: True if successful

Warning: During periodic detection runs, an error is returned; Blocked until the process is completed (about 400ms)

◆ performSelfTest()

bool m5::unit::UnitSCD40::performSelfTest ( bool & malfunction )

Perform self test.

Parameters

[out] True if malfunction detected

Returns: True if successful

Note: Takes 10 seconds to complete

Warning: During periodic detection runs, an error is returned

◆ readAmbientPressure()

bool m5::unit::UnitSCD40::readAmbientPressure ( uint16_t & pressure )

Read the ambient pressure.

Parameters

[out] presure Ambient pressure [hPa]

Returns: True if successful

◆ readAutomaticSelfCalibrationEnabled()

bool m5::unit::UnitSCD40::readAutomaticSelfCalibrationEnabled ( bool & enabled )

Check if automatic self calibration is enabled.

Parameters

[out] enabled True if automatic self calibration is enabled

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ readAutomaticSelfCalibrationTarget()

bool m5::unit::UnitSCD40::readAutomaticSelfCalibrationTarget ( uint16_t & ppm )

Read the value of the ASC baseline target.

Parameters

[out] ppm ASC target ppm

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ readSensorAltitude()

bool m5::unit::UnitSCD40::readSensorAltitude ( uint16_t & altitude )

Read the sensor altitude.

Parameters

[out] altitude Sensor altitude [m]

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ readSerialNumber() [1/2]

bool m5::unit::UnitSCD40::readSerialNumber ( char * serialNumber )

Read the serial number string.

Parameters

[out] serialNumber Output buffer

Returns: True if successful

Warning: Size must be at least 13 bytes; During periodic detection runs, an error is returned

◆ readSerialNumber() [2/2]

bool m5::unit::UnitSCD40::readSerialNumber ( uint64_t & serialNumber )

Read the serial number value.

Parameters

[out] serialNumber serial number value

Returns: True if successful

Note: The serial number is 48 bit

Warning: During periodic detection runs, an error is returned

◆ readTemperatureOffset()

bool m5::unit::UnitSCD40::readTemperatureOffset ( float & offset )

Read the temperature offset.

Parameters

[out] offset Offset value

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ reInit()

bool m5::unit::UnitSCD40::reInit ( const uint32_t duration = scd4x::REINIT_DURATION )

Re-initialize the sensor, load settings from EEPROM.

Returns: True if successful

Warning: During periodic detection runs, an error is returned; Measurement duration max 20 ms

◆ startLowPowerPeriodicMeasurement()

bool m5::unit::UnitSCD40::startLowPowerPeriodicMeasurement ( )

inline

Start low power periodic measurement.

Returns: True if successful

◆ startPeriodicMeasurement()

bool m5::unit::UnitSCD40::startPeriodicMeasurement ( const scd4x::Mode mode = scd4x::Mode::Normal )

inline

Start periodic measurement.

Parameters

mode	Measurement mode

Returns: True if successful

◆ stopPeriodicMeasurement()

bool m5::unit::UnitSCD40::stopPeriodicMeasurement ( const uint32_t duration = scd4x::STOP_PERIODIC_MEASUREMENT_DURATION )

inline

Stop periodic measurement.

Parameters

duration Max command duration(ms)

Returns: True if successful

◆ writeAmbientPressure()

bool m5::unit::UnitSCD40::writeAmbientPressure	(	const uint16_t	pressure,
		const uint32_t	duration = scd4x::SET_AMBIENT_PRESSURE_DURATION )

Write the ambient pressure.

Define the ambient pressure in Pascals, so RH and CO2 are compensated for atmospheric pressure setAmbientPressure overrides setSensorAltitude

Parameters

pressure	Ambient pressure [hPa]
duration	Max command duration(ms)

Returns: True if successful

Warning: Valid Valid input values are between 700 – 1200 hPa

◆ writeAutomaticSelfCalibrationEnabled()

bool m5::unit::UnitSCD40::writeAutomaticSelfCalibrationEnabled	(	const bool	enabled = true,
		const uint32_t	duration = scd4x::SET_AUTOMATIC_SELF_CALIBRATION_ENABLED_DURATION )

Enable/disable automatic self calibration.

Parameters

enabled	Enable automatic self calibration if true
duration	Max command duration(ms)

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ writeAutomaticSelfCalibrationTarget()

bool m5::unit::UnitSCD40::writeAutomaticSelfCalibrationTarget	(	const uint16_t	ppm,
		const uint32_t	duration = scd4x::SET_AUTOMATIC_SELF_CALIBRATION_TARGET_DURATION )

Write the value of the ASC baseline target.

Parameters

ppm	ASC target ppm
duration	Max command duration(ms)

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ writePersistSettings()

bool m5::unit::UnitSCD40::writePersistSettings ( const uint32_t duration = scd4x::PERSIST_SETTINGS_DURATION )

Write sensor settings from RAM to EEPROM.

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ writeSensorAltitude()

bool m5::unit::UnitSCD40::writeSensorAltitude	(	const uint16_t	altitude,
		const uint32_t	duration = scd4x::SET_SENSOR_ALTITUDE_DURATION )

Write the sensor altitude.

Define the sensor altitude in metres above sea level, so RH and CO2 arecompensated for atmospheric pressure Default altitude is 0m

Parameters

altitude	Sensor altitude [m]
duration	Max command duration(ms)

Returns: True if successful

Warning: During periodic detection runs, an error is returned

◆ writeTemperatureOffset()

bool m5::unit::UnitSCD40::writeTemperatureOffset	(	const float	offset,
		const uint32_t	duration = scd4x::SET_TEMPERATURE_OFFSET_DURATION )

Write the temperature offset.

Define how warm the sensor is compared to ambient, so RH and T are temperature compensated. Has no effect on the CO2 reading Default offsetis 4C

Parameters

offset	(0 <= offset < 175)
duration	Max command duration(ms)

Returns: True if successful

Note: Recommended temperature offset values are between 0 and 20

Warning: During periodic detection runs, an error is returned

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ performFactoryReset()

◆ performForcedRecalibration()

◆ performSelfTest()

◆ readAmbientPressure()

◆ readAutomaticSelfCalibrationEnabled()

◆ readAutomaticSelfCalibrationTarget()

◆ readSensorAltitude()

◆ readSerialNumber() [1/2]

◆ readSerialNumber() [2/2]

◆ readTemperatureOffset()

◆ reInit()

◆ startLowPowerPeriodicMeasurement()

◆ startPeriodicMeasurement()

◆ stopPeriodicMeasurement()

◆ writeAmbientPressure()

◆ writeAutomaticSelfCalibrationEnabled()

◆ writeAutomaticSelfCalibrationTarget()

◆ writePersistSettings()

◆ writeSensorAltitude()

◆ writeTemperatureOffset()