#include <flxDevENS160.h>

Inheritance diagram for flxDevENS160:

Public Member Functions
	flxDevENS160 ()
	Constructor. More...

bool	onInitialize (TwoWire &)
	Called during the startup/initialization of the driver (after the constructor is called). More...

void	setTemperatureCompParameter (flxParameterOutScalar &)
	method to set a parameter to use for temp compensation More...

void	setHumidityCompParameter (flxParameterOutScalar &)
	method to set a parameter to use for relative humidity compensation More...

Public Member Functions inherited from flxDeviceI2CType< flxDevENS160 >
virtual uint8_t	getDefaultAddress (void)

bool	initialize (TwoWire &wirePort)

bool	initialize (flxBusI2C &i2cDriver)

bool	initialize (void)

bool	initialize (uint8_t address)

virtual bool	onInitialize (TwoWire &)

flxTypeID	getType (void)

bool	isType (flxTypeID type)

flxDeviceKind_t	getKind (void)

Public Member Functions inherited from flxDevice
	flxDevice ()

virtual	~flxDevice ()

virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...

bool	initialize ()

virtual bool	initialize (flxBusI2C &)

virtual bool	initialize (flxBusSPI &)

bool	autoload (void)

void	setAutoload ()

void	setAddress (uint8_t address)

uint8_t	address (void)

void	addAddressToName ()

void	setIsInitialized (bool isInit)

bool	isInitialized (void)

virtual flxDeviceKind_t	getKind (void)

Public Member Functions inherited from flxOperation
virtual flxTypeID	getType (void)

virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...

virtual bool	onSave (flxStorageBlock *stBlk)

virtual bool	onRestore (flxStorageBlock *stBlk)

Public Member Functions inherited from flxObject
	flxObject ()

virtual	~flxObject ()

void	setParent (flxObject *parent)

void	setParent (flxObject &parent)

flxObject *	parent ()

void	setHidden (bool bHide=true)

bool	hidden ()

void	setIsDirty (bool bDirty=true)

bool	isDirty (void)

virtual bool	onSave (flxStorageBlock *stBlk)

virtual bool	save (flxStorage *pStorage)

virtual bool	onRestore (flxStorageBlock *stBlk)

virtual bool	restore (flxStorage *pStorage)

virtual flxTypeID	getType (void)

virtual bool	save (flxStorage *)=0

virtual bool	restore (flxStorage *)=0

Public Member Functions inherited from _flxPropertyContainer
	_flxPropertyContainer ()

void	addProperty (flxProperty *newProperty)

void	addProperty (flxProperty &newProperty)

void	removeProperty (flxProperty *rmProp)

void	removeProperty (flxProperty &rmProp)

flxPropertyList &	getProperties (void)

uint	nProperties (void)

bool	saveProperties (flxStorageBlock *stBlk)

bool	restoreProperties (flxStorageBlock *stBlk)

size_t	propertySaveSize ()

void	hideProperty (flxProperty &theProp)

Public Member Functions inherited from flxDescriptor
	flxDescriptor ()

void	setName (const char *new_name)
	Set the Name object - storing the pointer to the provided string No allocation is performed. If the previous name was allocated, it is freed. More...

void	setName (const char new_name, const char new_desc)
	Set the Name object and the Description for the object. Both strings are constants. More...

void	setName (char *new_name)
	Set the Name object, but makes a copy of the input string since the input is not const. If the previous name was allocated, it is freed. More...

const char *	name ()
	Return a const char pointer to the name of the object. More...

std::string	name_ (void)
	Returns a std::string of the name of the object. More...

void	setDescription (const char *new_desc)
	Set the Description object - the input value is constant and not copied. If the previous description was allocated, it is freed. More...

void	setDescription (char *new_desc)
	Set the Description object - the input value is not constant and is copied. If the previous description was allocated, it is freed. More...

const char *	description ()
	Return the constant C string pointer to the description of the object. More...

std::string	description_ (void)
	Return the description of the object as a std::string. More...

void	setTitle (const char *title)
	Set the Title object - the title is optional and is used mostly for UX or organizational purposes. The input value is constant and not copied. If the previous title was allocated, it is freed. More...

void	setTitleAlloc (char *new_title)
	Set the Title of the object , but make an explict copy of the provided string. More...

const char *	title (void)
	Return the C constant string pointer to the title of the object. More...

Public Member Functions inherited from _flxParameterContainer
void	addParameter (flxParameterIn *newParam, bool head=false)

void	addParameter (flxParameterIn &newParam, bool head=false)

void	removeParameter (flxParameterIn *rmParam)

void	removeParameter (flxParameterIn &rmParam)

size_t	nInputParameters ()

void	addParameter (flxParameterOut *newParam, bool head=false)

void	addParameter (flxParameterOut &newParam, bool head=false)

void	removeParameter (flxParameterOut *rmParam)

void	removeParameter (flxParameterOut &rmParam)

size_t	nOutputParameters ()

flxParameterOutList &	getOutputParameters (void)

flxParameterInList &	getInputParameters (void)

Static Public Member Functions
static bool	isConnected (flxBusI2C &i2cDriver, uint8_t address)
	Static method called to determine if device is connected. More...

static flxDeviceConfidence_t	connectedConfidence (void)

static const char *	getDeviceName ()

static const uint8_t *	getDefaultAddresses ()

Static Public Member Functions inherited from flxDeviceI2CType< flxDevENS160 >
static flxTypeID	type (void)

static flxDeviceKind_t	kind (void)

Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)

Public Attributes
flxPropertyRWUInt8< flxDevENS160, &flxDevENS160::get_operating_mode, &flxDevENS160::set_operating_mode >	operatingMode

flxPropertyBool< flxDevENS160 >	enableCompensation = true

flxPropertyRWUInt32< flxDevENS160, &flxDevENS160::get_update_period, &flxDevENS160::set_update_period >	updatePeriodSecs = {kENS160DefaultCompUpdateTimeSecs, 5, 600}

flxPropertyRWFloat< flxDevENS160, &flxDevENS160::read_TempC, &flxDevENS160::set_temp_comp >	tempComp

flxPropertyRWFloat< flxDevENS160, &flxDevENS160::read_RH, &flxDevENS160::set_humid_comp >	humidityComp

flxParameterOutUInt8< flxDevENS160, &flxDevENS160::read_AQI >	val_AQI

flxParameterOutUInt16< flxDevENS160, &flxDevENS160::read_TVOC >	val_TVOC

flxParameterOutUInt16< flxDevENS160, &flxDevENS160::read_ETOH >	val_ETOH

flxParameterOutUInt16< flxDevENS160, &flxDevENS160::read_ECO2 >	val_ECO2

flxParameterOutFloat< flxDevENS160, &flxDevENS160::read_TempC >	val_TempC

flxParameterOutFloat< flxDevENS160, &flxDevENS160::read_RH >	val_RH

Public Attributes inherited from flxDevice
flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >	disableAllParameters

flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >	enableAllParameters

Static Public Attributes
static uint8_t	defaultDeviceAddress [] = {ENS160_ADDRESS_HIGH, ENS160_ADDRESS_LOW, kSparkDeviceAddressNull}

Additional Inherited Members
Protected Attributes inherited from flxDescriptor
const char *	_name

bool	_nameAlloc

const char *	_desc

bool	_descAlloc

const char *	_title

bool	_titleAlloc

Constructor & Destructor Documentation

◆ flxDevENS160()

flxDevENS160::flxDevENS160 ( )

Constructor.

Member Function Documentation

◆ connectedConfidence()

static flxDeviceConfidence_t flxDevENS160::connectedConfidence ( void )

inlinestatic

◆ getDefaultAddresses()

static const uint8_t * flxDevENS160::getDefaultAddresses ( )

inlinestatic

◆ getDeviceName()

static const char * flxDevENS160::getDeviceName ( )

inlinestatic

◆ isConnected()

bool flxDevENS160::isConnected	(	flxBusI2C &	i2cDriver,
		uint8_t	address
	)

static

Static method called to determine if device is connected.

Parameters

i2cDriver	- Framework i2c bus driver
address	- The address to check

Returns: true if the device is connected

◆ onInitialize()

bool flxDevENS160::onInitialize ( TwoWire & wirePort )

virtual

Called during the startup/initialization of the driver (after the constructor is called).

Parameters

wirePort - The Arduino wire port for the I2C bus

Returns: true on success

Reimplemented from flxDeviceI2CType< flxDevENS160 >.

◆ setHumidityCompParameter()

void flxDevENS160::setHumidityCompParameter ( flxParameterOutScalar & compParam )

method to set a parameter to use for relative humidity compensation

Parameters

compParam - the input parameter to pull humidity compensation values from

◆ setTemperatureCompParameter()

void flxDevENS160::setTemperatureCompParameter ( flxParameterOutScalar & compParam )

method to set a parameter to use for temp compensation

Parameters

compParam - the input parameter to pull Temp compensation values from

Member Data Documentation

◆ defaultDeviceAddress

uint8_t flxDevENS160::defaultDeviceAddress = {ENS160_ADDRESS_HIGH, ENS160_ADDRESS_LOW, kSparkDeviceAddressNull}

static

◆ enableCompensation

flxPropertyBool<flxDevENS160> flxDevENS160::enableCompensation = true

◆ humidityComp

flxPropertyRWFloat<flxDevENS160, &flxDevENS160::read_RH, &flxDevENS160::set_humid_comp> flxDevENS160::humidityComp

◆ operatingMode

flxPropertyRWUInt8<flxDevENS160, &flxDevENS160::get_operating_mode, &flxDevENS160::set_operating_mode> flxDevENS160::operatingMode

Initial value:

= {
            SFE_ENS160_STANDARD,
            {{"Standard", SFE_ENS160_STANDARD}, {"Idle", SFE_ENS160_IDLE}, {"Deep Sleep", SFE_ENS160_DEEP_SLEEP}}}

◆ tempComp

flxPropertyRWFloat<flxDevENS160, &flxDevENS160::read_TempC, &flxDevENS160::set_temp_comp> flxDevENS160::tempComp

◆ updatePeriodSecs

flxPropertyRWUInt32<flxDevENS160, &flxDevENS160::get_update_period, &flxDevENS160::set_update_period> flxDevENS160::updatePeriodSecs = {kENS160DefaultCompUpdateTimeSecs, 5, 600}

◆ val_AQI

flxParameterOutUInt8<flxDevENS160, &flxDevENS160::read_AQI> flxDevENS160::val_AQI

◆ val_ECO2

flxParameterOutUInt16<flxDevENS160, &flxDevENS160::read_ECO2> flxDevENS160::val_ECO2

◆ val_ETOH

flxParameterOutUInt16<flxDevENS160, &flxDevENS160::read_ETOH> flxDevENS160::val_ETOH

◆ val_RH

flxParameterOutFloat<flxDevENS160, &flxDevENS160::read_RH> flxDevENS160::val_RH

◆ val_TempC

flxParameterOutFloat<flxDevENS160, &flxDevENS160::read_TempC> flxDevENS160::val_TempC

◆ val_TVOC

flxParameterOutUInt16<flxDevENS160, &flxDevENS160::read_TVOC> flxDevENS160::val_TVOC

The documentation for this class was generated from the following files:

src/device/device_ens160/flxDevENS160.h
src/device/device_ens160/flxDevENS160.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ flxDevENS160()

Member Function Documentation

◆ connectedConfidence()

◆ getDefaultAddresses()

◆ getDeviceName()

◆ isConnected()

◆ onInitialize()

◆ setHumidityCompParameter()

◆ setTemperatureCompParameter()

Member Data Documentation

◆ defaultDeviceAddress

◆ enableCompensation

◆ humidityComp

◆ operatingMode

◆ tempComp

◆ updatePeriodSecs

◆ val_AQI

◆ val_ECO2

◆ val_ETOH

◆ val_RH

◆ val_TempC

◆ val_TVOC