flxDevSerial Class Reference

A class to interface with the SparkFun Soil Moisture sensor. More...

#include <flxDevSerial.h>

Inheritance diagram for flxDevSerial:

Public Member Functions
	flxDevSerial ()
	Default constructor for the flxDevSerial class. More...
bool	onInitialize (void)
	Method called to initialize the class. More...
void	setSerialPort (HardwareSerial *serialPort)
Public Member Functions inherited from flxDeviceGPIOType< flxDevSerial >
virtual bool	onInitialize (void)
bool	initialize (void)
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 ()
virtual size_t	n_children (void)
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 void	restoreComplete (void)
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)
bool	containsProperty (flxProperty *prop)
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 const char *	getDeviceName ()
	Get the device name. More...
Static Public Member Functions inherited from flxDeviceGPIOType< flxDevSerial >
static flxTypeID	type (void)
static flxDeviceKind_t	kind (void)
Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)

Public Attributes
flxPropertyRWBool< flxDevSerial, &flxDevSerial::get_is_enabled, &flxDevSerial::set_is_enabled >	isEnabled = {false}
flxParameterOutString< flxDevSerial, &flxDevSerial::read_serial_value >	serialValue
Public Attributes inherited from flxDevice
flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >	disableAllParameters
flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >	enableAllParameters

Additional Inherited Members
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Detailed Description

A class to interface with the SparkFun Soil Moisture sensor.

This class provides methods to initialize the sensor, read moisture values, and calibrate the sensor for dry and wet states. It also includes properties to enable the sensor, set the GPIO pins, and retrieve the moisture values.

Constructor & Destructor Documentation

flxDevSerial()

flxDevSerial::flxDevSerial

(

)

Default constructor for the flxDevSerial class.

Member Function Documentation

getDeviceName()

static const char * flxDevSerial::getDeviceName ( )

inlinestatic

Get the device name.

Returns

The name of the device.

onInitialize()

bool flxDevSerial::onInitialize ( void  )

virtual

Method called to initialize the class.

Returns

True if initialization is successful, false otherwise.

Reimplemented from flxDeviceGPIOType< flxDevSerial >.

setSerialPort()

void flxDevSerial::setSerialPort

(

HardwareSerial *

serialPort

)

Member Data Documentation

isEnabled

flxPropertyRWBool<flxDevSerial, &flxDevSerial::get_is_enabled, &flxDevSerial::set_is_enabled> flxDevSerial::isEnabled = {false}

serialValue

flxParameterOutString<flxDevSerial, &flxDevSerial::read_serial_value> flxDevSerial::serialValue

---

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

• src/opt/opt_extserial/flxDevSerial.h
• src/opt/opt_extserial/flxDevSerial.cpp