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

#include <flxDevADS1015.h>

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

Public Member Functions

 flxDevADS1015 ()
 
bool onInitialize (TwoWire &)
 
- Public Member Functions inherited from flxDeviceI2CType< flxDevADS1015 >
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< flxDevADS1015 >
static flxTypeID type (void)
 
static flxDeviceKind_t kind (void)
 
- Static Public Member Functions inherited from flxObject
static flxTypeID type (void)
 

Public Attributes

flxPropertyRWUInt16< flxDevADS1015, &flxDevADS1015::get_sample_rate, &flxDevADS1015::set_sample_rate > sampleRate
 
flxPropertyRWUInt16< flxDevADS1015, &flxDevADS1015::get_pga_gain, &flxDevADS1015::set_pga_gain > gain
 
flxPropertyRWUInt8< flxDevADS1015, &flxDevADS1015::get_se_type, &flxDevADS1015::set_se_type > singleEndedType
 
flxPropertyRWUInt8< flxDevADS1015, &flxDevADS1015::get_diff_type, &flxDevADS1015::set_diff_type > differentialType
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_single_0 > channel0_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_single_1 > channel1_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_single_2 > channel2_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_single_3 > channel3_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_differential_P0_N1 > differential_0_minus_1_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_differential_P0_N3 > differential_0_minus_3_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_differential_P1_N3 > differential_1_minus_3_f
 
flxParameterOutFloat< flxDevADS1015, &flxDevADS1015::readf_differential_P2_N3 > differential_2_minus_3_f
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_single_0 > channel0_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_single_1 > channel1_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_single_2 > channel2_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_single_3 > channel3_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_differential_P0_N1 > differential_0_minus_1_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_differential_P0_N3 > differential_0_minus_3_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_differential_P1_N3 > differential_1_minus_3_i
 
flxParameterOutInt16< flxDevADS1015, &flxDevADS1015::readi_differential_P2_N3 > differential_2_minus_3_i
 
flxParameterOutUInt16< flxDevADS1015, &flxDevADS1015::readu_single_0 > channel0_u
 
flxParameterOutUInt16< flxDevADS1015, &flxDevADS1015::readu_single_1 > channel1_u
 
flxParameterOutUInt16< flxDevADS1015, &flxDevADS1015::readu_single_2 > channel2_u
 
flxParameterOutUInt16< flxDevADS1015, &flxDevADS1015::readu_single_3 > channel3_u
 
- 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 [] = {0x48, 0x49, 0x4A, 0x4B, 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

◆ flxDevADS1015()

flxDevADS1015::flxDevADS1015 ( )

Member Function Documentation

◆ connectedConfidence()

static flxDeviceConfidence_t flxDevADS1015::connectedConfidence ( void  )
inlinestatic

◆ getDefaultAddresses()

static const uint8_t * flxDevADS1015::getDefaultAddresses ( )
inlinestatic

◆ getDeviceName()

static const char * flxDevADS1015::getDeviceName ( )
inlinestatic

◆ isConnected()

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

◆ onInitialize()

bool flxDevADS1015::onInitialize ( TwoWire &  wirePort)
virtual

Reimplemented from flxDeviceI2CType< flxDevADS1015 >.

Member Data Documentation

◆ channel0_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_single_0> flxDevADS1015::channel0_f

◆ channel0_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_single_0> flxDevADS1015::channel0_i

◆ channel0_u

flxParameterOutUInt16<flxDevADS1015, &flxDevADS1015::readu_single_0> flxDevADS1015::channel0_u

◆ channel1_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_single_1> flxDevADS1015::channel1_f

◆ channel1_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_single_1> flxDevADS1015::channel1_i

◆ channel1_u

flxParameterOutUInt16<flxDevADS1015, &flxDevADS1015::readu_single_1> flxDevADS1015::channel1_u

◆ channel2_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_single_2> flxDevADS1015::channel2_f

◆ channel2_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_single_2> flxDevADS1015::channel2_i

◆ channel2_u

flxParameterOutUInt16<flxDevADS1015, &flxDevADS1015::readu_single_2> flxDevADS1015::channel2_u

◆ channel3_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_single_3> flxDevADS1015::channel3_f

◆ channel3_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_single_3> flxDevADS1015::channel3_i

◆ channel3_u

flxParameterOutUInt16<flxDevADS1015, &flxDevADS1015::readu_single_3> flxDevADS1015::channel3_u

◆ defaultDeviceAddress

uint8_t flxDevADS1015::defaultDeviceAddress = {0x48, 0x49, 0x4A, 0x4B, kSparkDeviceAddressNull}
static

◆ differential_0_minus_1_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_differential_P0_N1> flxDevADS1015::differential_0_minus_1_f

◆ differential_0_minus_1_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_differential_P0_N1> flxDevADS1015::differential_0_minus_1_i

◆ differential_0_minus_3_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_differential_P0_N3> flxDevADS1015::differential_0_minus_3_f

◆ differential_0_minus_3_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_differential_P0_N3> flxDevADS1015::differential_0_minus_3_i

◆ differential_1_minus_3_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_differential_P1_N3> flxDevADS1015::differential_1_minus_3_f

◆ differential_1_minus_3_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_differential_P1_N3> flxDevADS1015::differential_1_minus_3_i

◆ differential_2_minus_3_f

flxParameterOutFloat<flxDevADS1015, &flxDevADS1015::readf_differential_P2_N3> flxDevADS1015::differential_2_minus_3_f

◆ differential_2_minus_3_i

flxParameterOutInt16<flxDevADS1015, &flxDevADS1015::readi_differential_P2_N3> flxDevADS1015::differential_2_minus_3_i

◆ differentialType

flxPropertyRWUInt8<flxDevADS1015, &flxDevADS1015::get_diff_type, &flxDevADS1015::set_diff_type> flxDevADS1015::differentialType
Initial value:
= {
kADS1015DeviceFloat, {{"Float", kADS1015DeviceFloat}, {"Integer", kADS1015DeviceInt}}}

◆ gain

flxPropertyRWUInt16<flxDevADS1015, &flxDevADS1015::get_pga_gain, &flxDevADS1015::set_pga_gain> flxDevADS1015::gain
Initial value:
= {
ADS1015_CONFIG_PGA_2,
{{"x2/3", ADS1015_CONFIG_PGA_TWOTHIRDS},
{"x1", ADS1015_CONFIG_PGA_1},
{"x2", ADS1015_CONFIG_PGA_2},
{"x4", ADS1015_CONFIG_PGA_4},
{"x8", ADS1015_CONFIG_PGA_8},
{"x16", ADS1015_CONFIG_PGA_16}}}

◆ sampleRate

flxPropertyRWUInt16<flxDevADS1015, &flxDevADS1015::get_sample_rate, &flxDevADS1015::set_sample_rate> flxDevADS1015::sampleRate
Initial value:
= {
ADS1015_CONFIG_RATE_1600HZ,
{{"128 Hz", ADS1015_CONFIG_RATE_128HZ},
{"250 Hz", ADS1015_CONFIG_RATE_250HZ},
{"490 Hz", ADS1015_CONFIG_RATE_490HZ},
{"920 Hz", ADS1015_CONFIG_RATE_920HZ},
{"1600 Hz", ADS1015_CONFIG_RATE_1600HZ},
{"2400 Hz", ADS1015_CONFIG_RATE_2400HZ},
{"3300 Hz", ADS1015_CONFIG_RATE_3300HZ}}}

◆ singleEndedType

flxPropertyRWUInt8<flxDevADS1015, &flxDevADS1015::get_se_type, &flxDevADS1015::set_se_type> flxDevADS1015::singleEndedType
Initial value:
= {
kADS1015DeviceFloat,
{{"Float", kADS1015DeviceFloat}, {"Integer", kADS1015DeviceInt}, {"Unsigned", kADS1015DeviceUnsigned}}}

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