AdafruitIO_Dashboard Class Reference

Class for interacting with Adafruit IO Dashboards. https://io.adafruit.com/api/docs/#dashboards. More...

#include <AdafruitIO_Dashboard.h>

Public Member Functions
	AdafruitIO_Dashboard (AdafruitIO *io, const char *name)
	Sets Adafruit IO Dashboard instance. More...
const char *	user ()
	Returns the dashboard owner. More...
AdafruitIO *	io ()
	Creates an instance of AdafruitIO. More...
bool	exists ()
	Checks if Adafruit IO Dashboard exists. https://io.adafruit.com/api/docs/#return-dashboard. More...
bool	create ()
	Creates a new dashboard. https://io.adafruit.com/api/docs/#create-a-dashboard. More...
ToggleBlock *	addToggleBlock (AdafruitIO_Feed *feed)
	Creates a new toggle block element on a dashboard connected to provided feed. More...
MomentaryBlock *	addMomentaryBlock (AdafruitIO_Feed *feed)
	Creates a new momentary block element on a dashboard connected to provided feed. More...
SliderBlock *	addSliderBlock (AdafruitIO_Feed *feed)
	Creates a new slider block element on a dashboard connected to provided feed. More...
GaugeBlock *	addGaugeBlock (AdafruitIO_Feed *feed)
	Creates a new gauge block element on a dashboard connected to provided feed. More...
TextBlock *	addTextBlock (AdafruitIO_Feed *feed)
	Creates a new momentary block element on a dashboard connected to provided feed. More...
ChartBlock *	addChartBlock (AdafruitIO_Feed *feed)
	Creates a new chart block element on a dashboard connected to provided feed. More...
ColorBlock *	addColorBlock (AdafruitIO_Feed *feed)
	Creates a new color block element on a dashboard connected to provided feed. More...
MapBlock *	addMapBlock (AdafruitIO_Feed *feed)
	Creates a new map block element on a dashboard connected to provided feed. More...
StreamBlock *	addStreamBlock (AdafruitIO_Feed *feed)
	Creates a new stream block element on a dashboard connected to provided feed. More...
ImageBlock *	addImageBlock (AdafruitIO_Feed *feed)
	Creates a new image block element on a dashboard connected to provided feed. More...

Public Attributes
const char *	name

Friends
class	AdafruitIO_Dashboard
	AdafruitIO_Dashboard addition.

Detailed Description

Class for interacting with Adafruit IO Dashboards. https://io.adafruit.com/api/docs/#dashboards.

Constructor & Destructor Documentation

AdafruitIO_Dashboard()

AdafruitIO_Dashboard::AdafruitIO_Dashboard	(	AdafruitIO *	io,
		const char *	n
	)

Sets Adafruit IO Dashboard instance.

Parameters

*io	Reference to Adafruit IO class.
*n	Valid username string.

Member Function Documentation

user()

const char * AdafruitIO_Dashboard::user

(

)

Returns the dashboard owner.

Dashboard owner's Adafruit IO username.

Returns

Adafruit IO username.

io()

AdafruitIO * AdafruitIO_Dashboard::io

(

)

Creates an instance of AdafruitIO.

Returns

True

exists()

bool AdafruitIO_Dashboard::exists

(

)

Checks if Adafruit IO Dashboard exists. https://io.adafruit.com/api/docs/#return-dashboard.

Returns

True if successful, otherwise False.

create()

bool AdafruitIO_Dashboard::create

(

)

Creates a new dashboard. https://io.adafruit.com/api/docs/#create-a-dashboard.

Returns

True if successful, otherwise False.

addToggleBlock()

ToggleBlock * AdafruitIO_Dashboard::addToggleBlock

(

AdafruitIO_Feed *

feed

)

Creates a new toggle block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Toggle block dashboard element.

addMomentaryBlock()

MomentaryBlock * AdafruitIO_Dashboard::addMomentaryBlock

(

AdafruitIO_Feed *

feed

)

Creates a new momentary block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Momentary block dashboard element.

addSliderBlock()

SliderBlock * AdafruitIO_Dashboard::addSliderBlock

(

AdafruitIO_Feed *

feed

)

Creates a new slider block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Slider block dashboard element.

addGaugeBlock()

GaugeBlock * AdafruitIO_Dashboard::addGaugeBlock

(

AdafruitIO_Feed *

feed

)

Creates a new gauge block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Gauge block dashboard element.

addTextBlock()

TextBlock * AdafruitIO_Dashboard::addTextBlock

(

AdafruitIO_Feed *

feed

)

Creates a new momentary block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Text block dashboard element.

addChartBlock()

ChartBlock * AdafruitIO_Dashboard::addChartBlock

(

AdafruitIO_Feed *

feed

)

Creates a new chart block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Chart block dashboard element.

addColorBlock()

ColorBlock * AdafruitIO_Dashboard::addColorBlock

(

AdafruitIO_Feed *

feed

)

Creates a new color block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Color block dashboard element.

addMapBlock()

MapBlock * AdafruitIO_Dashboard::addMapBlock

(

AdafruitIO_Feed *

feed

)

Creates a new map block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Map block dashboard element.

addStreamBlock()

StreamBlock * AdafruitIO_Dashboard::addStreamBlock

(

AdafruitIO_Feed *

feed

)

Creates a new stream block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Stream block dashboard element.

addImageBlock()

ImageBlock * AdafruitIO_Dashboard::addImageBlock

(

AdafruitIO_Feed *

feed

)

Creates a new image block element on a dashboard connected to provided feed.

Parameters

*feed

Reference to an Adafruit IO feed.

Returns

Image block dashboard element.

Member Data Documentation

name

const char* AdafruitIO_Dashboard::name

Dashboard name.

---

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

• src/AdafruitIO_Dashboard.h
• src/AdafruitIO.h
• src/AdafruitIO_Dashboard.cpp