flux sdk  v01.02.02-3-g292b3a7
Embedded C++ SDK
Loading...
Searching...
No Matches
flxDevVEML6075 Class Reference

#include <flxDevVEML6075.h>

Inheritance diagram for flxDevVEML6075:
flxDeviceI2CType< flxDevVEML6075 > flxDevice flxOperation flxObject _flxParameterContainer flxPersist _flxPropertyContainer flxDescriptor

Public Member Functions

 flxDevVEML6075 ()
 
bool onInitialize (TwoWire &)
 
- Public Member Functions inherited from flxDeviceI2CType< flxDevVEML6075 >
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)
 
flxObjectparent ()
 
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)
 
flxPropertyListgetProperties (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 ()
 
flxParameterOutListgetOutputParameters (void)
 
flxParameterInListgetInputParameters (void)
 

Static Public Member Functions

static bool isConnected (flxBusI2C &i2cDriver, uint8_t address)
 
static flxDeviceConfidence_t connectedConfidence (void)
 
static const char * getDeviceName ()
 
static const uint8_t * getDefaultAddresses ()
 
- Static Public Member Functions inherited from flxDeviceI2CType< flxDevVEML6075 >
static flxTypeID type (void)
 
static flxDeviceKind_t kind (void)
 
- Static Public Member Functions inherited from flxObject
static flxTypeID type (void)
 

Public Attributes

flxPropertyRWUInt8< flxDevVEML6075, &flxDevVEML6075::get_integration_time, &flxDevVEML6075::set_integration_time > integrationTime
 
flxPropertyRWUInt8< flxDevVEML6075, &flxDevVEML6075::get_high_dynamic, &flxDevVEML6075::set_high_dynamic > highDynamic
 
flxParameterOutFloat< flxDevVEML6075, &flxDevVEML6075::read_uva > uva
 
flxParameterOutFloat< flxDevVEML6075, &flxDevVEML6075::read_uvb > uvb
 
flxParameterOutFloat< flxDevVEML6075, &flxDevVEML6075::read_uv_index > uvIndex
 
- 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 [] = {kVEML6075AddressDefault, 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

◆ flxDevVEML6075()

flxDevVEML6075::flxDevVEML6075 ( )

Member Function Documentation

◆ connectedConfidence()

static flxDeviceConfidence_t flxDevVEML6075::connectedConfidence ( void  )
inlinestatic

◆ getDefaultAddresses()

static const uint8_t * flxDevVEML6075::getDefaultAddresses ( )
inlinestatic

◆ getDeviceName()

static const char * flxDevVEML6075::getDeviceName ( )
inlinestatic

◆ isConnected()

bool flxDevVEML6075::isConnected ( flxBusI2C i2cDriver,
uint8_t  address 
)
static

◆ onInitialize()

bool flxDevVEML6075::onInitialize ( TwoWire &  wirePort)
virtual

Member Data Documentation

◆ defaultDeviceAddress

uint8_t flxDevVEML6075::defaultDeviceAddress = {kVEML6075AddressDefault, kSparkDeviceAddressNull}
static

◆ highDynamic

flxPropertyRWUInt8<flxDevVEML6075, &flxDevVEML6075::get_high_dynamic, &flxDevVEML6075::set_high_dynamic> flxDevVEML6075::highDynamic
Initial value:
= {VEML6075::DYNAMIC_NORMAL,
{{"Normal Dynamic", VEML6075::DYNAMIC_NORMAL}, {"High Dynamic", VEML6075::DYNAMIC_HIGH}}}

◆ integrationTime

flxPropertyRWUInt8<flxDevVEML6075, &flxDevVEML6075::get_integration_time, &flxDevVEML6075::set_integration_time> flxDevVEML6075::integrationTime
Initial value:
= {VEML6075::IT_100MS,
{{"50ms", VEML6075::IT_50MS},
{"100ms", VEML6075::IT_100MS},
{"200ms", VEML6075::IT_200MS},
{"400ms", VEML6075::IT_400MS},
{"800ms", VEML6075::IT_800MS}}}

◆ uva

flxParameterOutFloat<flxDevVEML6075, &flxDevVEML6075::read_uva> flxDevVEML6075::uva

◆ uvb

flxParameterOutFloat<flxDevVEML6075, &flxDevVEML6075::read_uvb> flxDevVEML6075::uvb

◆ uvIndex

flxParameterOutFloat<flxDevVEML6075, &flxDevVEML6075::read_uv_index> flxDevVEML6075::uvIndex

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