flxIoTArduino Class Reference

A framework action that encapsulates the connection to the Arduino IoT Cloud. More...

#include <flxIoTArduino.h>

Inheritance diagram for flxIoTArduino:

Public Member Functions
	flxIoTArduino ()
	~flxIoTArduino ()
void	write (JsonDocument &jsonDoc)
	Interface method - called with data to write to the cloud. More...
void	setNetwork (flxNetwork *theNetwork)
	API method used to set the system network connection. More...
bool	connected ()
	Are we connected to the cloud? More...
Public Member Functions inherited from flxActionType< flxIoTArduino >
flxTypeID	getType (void)
Public Member Functions inherited from flxAction
virtual bool	initialize (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)
virtual void	write (JsonDocument &jsonDoc)=0

Public Attributes
flxPropertyRWString< flxIoTArduino, &flxIoTArduino::get_thingName, &flxIoTArduino::set_thingName >	thingName
flxPropertyRWSecureString< flxIoTArduino, &flxIoTArduino::get_thingID, &flxIoTArduino::set_thingID >	thingID
flxPropertySecureString< flxIoTArduino >	cloudAPIClientID
flxPropertySecureString< flxIoTArduino >	cloudAPISecret
flxPropertySecureString< flxIoTArduino >	deviceSecret
flxPropertySecureString< flxIoTArduino >	deviceID
flxPropertyRWBool< flxIoTArduino, &flxIoTArduino::get_isEnabled, &flxIoTArduino::set_isEnabled >	enabled

Additional Inherited Members
Static Public Member Functions inherited from flxActionType< flxIoTArduino >
static flxTypeID	type (void)
Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Detailed Description

A framework action that encapsulates the connection to the Arduino IoT Cloud.

Note

Also implements the flxIWriterJSON interface, so it receives update data as a JSON doc.

Constructor & Destructor Documentation

flxIoTArduino()

flxIoTArduino::flxIoTArduino ( )

inline

~flxIoTArduino()

flxIoTArduino::~flxIoTArduino ( )

inline

Member Function Documentation

connected()

bool flxIoTArduino::connected ( )

inline

Are we connected to the cloud?

---

Returns

true if connected yes, false if not connected

setNetwork()

void flxIoTArduino::setNetwork ( flxNetwork *  theNetwork )

inline

API method used to set the system network connection.

---

Note

Will register for network connectivity change events

Parameters

theNetwork

The network object.

write()

void flxIoTArduino::write ( JsonDocument &  jDoc )

virtual

Interface method - called with data to write to the cloud.

Receives a JSON Document that contains the current values to output.

Note

This method is part of the flxIWriterJSON interface

Parameters

jDoc	The JSON Document that contains the values to output.

Implements flxIWriterJSON.

Member Data Documentation

cloudAPIClientID

flxPropertySecureString<flxIoTArduino> flxIoTArduino::cloudAPIClientID

cloudAPISecret

flxPropertySecureString<flxIoTArduino> flxIoTArduino::cloudAPISecret

deviceID

flxPropertySecureString<flxIoTArduino> flxIoTArduino::deviceID

deviceSecret

flxPropertySecureString<flxIoTArduino> flxIoTArduino::deviceSecret

enabled

flxPropertyRWBool<flxIoTArduino, &flxIoTArduino::get_isEnabled, &flxIoTArduino::set_isEnabled> flxIoTArduino::enabled

thingID

flxPropertyRWSecureString<flxIoTArduino, &flxIoTArduino::get_thingID, &flxIoTArduino::set_thingID> flxIoTArduino::thingID

thingName

flxPropertyRWString<flxIoTArduino, &flxIoTArduino::get_thingName, &flxIoTArduino::set_thingName> flxIoTArduino::thingName

---

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

• src/iot/iot_arduino/flxIoTArduino.h
• src/iot/iot_arduino/flxIoTArduino.cpp