flxDevButton Class Reference

#include <flxDevButton.h>

Inheritance diagram for flxDevButton:

Public Member Functions
	flxDevButton ()
bool	onInitialize (TwoWire &)
Public Member Functions inherited from flxDeviceI2CType< flxDevButton >
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 flxDeviceConfidence_t	connectedConfidence (void)
static const char *	getDeviceName ()
static const uint8_t *	getDefaultAddresses ()
Static Public Member Functions inherited from flxDeviceI2CType< flxDevButton >
static flxTypeID	type (void)
static flxDeviceKind_t	kind (void)
Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)

Public Attributes
flxSignalBool	on_clicked
flxPropertyRWUInt8< flxDevButton, &flxDevButton::get_press_mode, &flxDevButton::set_press_mode >	pressMode
flxPropertyRWUInt8< flxDevButton, &flxDevButton::get_led_brightness, &flxDevButton::set_led_brightness >	ledBrightness
flxParameterOutBool< flxDevButton, &flxDevButton::read_button_state >	buttonState
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 []

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

flxDevButton()

flxDevButton::flxDevButton

(

)

Member Function Documentation

connectedConfidence()

static flxDeviceConfidence_t flxDevButton::connectedConfidence ( void  )

inlinestatic

getDefaultAddresses()

static const uint8_t * flxDevButton::getDefaultAddresses ( )

inlinestatic

getDeviceName()

static const char * flxDevButton::getDeviceName ( )

inlinestatic

isConnected()

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

static

onInitialize()

bool flxDevButton::onInitialize ( TwoWire &  wirePort )

virtual

Reimplemented from flxDeviceI2CType< flxDevButton >.

Member Data Documentation

buttonState

flxParameterOutBool<flxDevButton, &flxDevButton::read_button_state> flxDevButton::buttonState

defaultDeviceAddress

uint8_t flxDevButton::defaultDeviceAddress

static

Initial value:

= {
    0x6F, 0x6E, 0x6D, 0x6C, 0x6B, 0x6A, 0x69, 0x68, kSparkDeviceAddressNull}

ledBrightness

flxPropertyRWUInt8<flxDevButton, &flxDevButton::get_led_brightness, &flxDevButton::set_led_brightness> flxDevButton::ledBrightness

on_clicked

flxSignalBool flxDevButton::on_clicked

pressMode

flxPropertyRWUInt8<flxDevButton, &flxDevButton::get_press_mode, &flxDevButton::set_press_mode> flxDevButton::pressMode

Initial value:

= {
        1, {{"Click (Toggle) Mode", 0}, {"Press Mode", 1}}}

---

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

• src/device/device_button/flxDevButton.h
• src/device/device_button/flxDevButton.cpp