Adafruit IO Arduino Library
AdafruitIO_Dashboard.h
Go to the documentation of this file.
1 
15 #ifndef ADAFRUITIO_DASHBOARD_H
16 #define ADAFRUITIO_DASHBOARD_H
17 
18 #include "AdafruitIO_Definitions.h"
19 #include "Arduino.h"
20 #include "blocks/ChartBlock.h"
21 #include "blocks/ColorBlock.h"
22 #include "blocks/GaugeBlock.h"
23 #include "blocks/ImageBlock.h"
24 #include "blocks/MapBlock.h"
25 #include "blocks/MomentaryBlock.h"
26 #include "blocks/SliderBlock.h"
27 #include "blocks/StreamBlock.h"
28 #include "blocks/TextBlock.h"
29 #include "blocks/ToggleBlock.h"
30 
31 // forward declaration
32 class AdafruitIO;
33 class AdafruitIO_Feed;
34 
35 /**************************************************************************/
40 /**************************************************************************/
41 class AdafruitIO_Dashboard {
42 
43 public:
44  AdafruitIO_Dashboard(AdafruitIO *io, const char *name);
45  ~AdafruitIO_Dashboard();
46 
47  const char *name;
48  const char *user();
50  /**************************************************************************/
55  /**************************************************************************/
56  AdafruitIO *io();
57 
58  bool exists();
59  bool create();
60 
61  ToggleBlock *addToggleBlock(AdafruitIO_Feed *feed);
62  MomentaryBlock *addMomentaryBlock(AdafruitIO_Feed *feed);
63  SliderBlock *addSliderBlock(AdafruitIO_Feed *feed);
64  GaugeBlock *addGaugeBlock(AdafruitIO_Feed *feed);
65  TextBlock *addTextBlock(AdafruitIO_Feed *feed);
66  ChartBlock *addChartBlock(AdafruitIO_Feed *feed);
67  ColorBlock *addColorBlock(AdafruitIO_Feed *feed);
68  MapBlock *addMapBlock(AdafruitIO_Feed *feed);
69  StreamBlock *addStreamBlock(AdafruitIO_Feed *feed);
70  ImageBlock *addImageBlock(AdafruitIO_Feed *feed);
71 
72 private:
73  AdafruitIO *_io;
74 };
75 
76 #endif // ADAFRUITIO_DASHBOARD_H
AdafruitIO_Dashboard::name
const char * name
Definition: AdafruitIO_Dashboard.h:47
AdafruitIO_Dashboard::addStreamBlock
StreamBlock * addStreamBlock(AdafruitIO_Feed *feed)
Creates a new stream block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:219
AdafruitIO
Class for interacting with Adafruit IO.
Definition: AdafruitIO.h:45
AdafruitIO_Dashboard::create
bool create()
Creates a new dashboard. https://io.adafruit.com/api/docs/#create-a-dashboard.
Definition: AdafruitIO_Dashboard.cpp:66
AdafruitIO_Dashboard::addChartBlock
ChartBlock * addChartBlock(AdafruitIO_Feed *feed)
Creates a new chart block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:180
AdafruitIO_Dashboard::user
const char * user()
Returns the dashboard owner.
Definition: AdafruitIO_Dashboard.cpp:102
AdafruitIO_Dashboard::exists
bool exists()
Checks if Adafruit IO Dashboard exists. https://io.adafruit.com/api/docs/#return-dashboard.
Definition: AdafruitIO_Dashboard.cpp:42
AdafruitIO_Dashboard::addMomentaryBlock
MomentaryBlock * addMomentaryBlock(AdafruitIO_Feed *feed)
Creates a new momentary block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:128
AdafruitIO_Dashboard::addGaugeBlock
GaugeBlock * addGaugeBlock(AdafruitIO_Feed *feed)
Creates a new gauge block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:154
AdafruitIO_Dashboard
Class for interacting with Adafruit IO Dashboards. https://io.adafruit.com/api/docs/#dashboards.
Definition: AdafruitIO_Dashboard.h:41
AdafruitIO_Definitions.h
AdafruitIO_Feed
Class that provides methods for interfacing with Adafruit IO feed topics. https://io.adafruit.com/api/docs/mqtt.html#mqtt-topics.
Definition: AdafruitIO_Feed.h:34
AdafruitIO_Dashboard::addTextBlock
TextBlock * addTextBlock(AdafruitIO_Feed *feed)
Creates a new momentary block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:167
AdafruitIO_Dashboard::addColorBlock
ColorBlock * addColorBlock(AdafruitIO_Feed *feed)
Creates a new color block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:193
AdafruitIO_Dashboard::addImageBlock
ImageBlock * addImageBlock(AdafruitIO_Feed *feed)
Creates a new image block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:232
AdafruitIO_Dashboard::AdafruitIO_Dashboard
friend class AdafruitIO_Dashboard
AdafruitIO_Dashboard addition.
Definition: AdafruitIO.h:62
AdafruitIO_Dashboard::addSliderBlock
SliderBlock * addSliderBlock(AdafruitIO_Feed *feed)
Creates a new slider block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:141
AdafruitIO_Dashboard::io
AdafruitIO * io()
Creates an instance of AdafruitIO.
Definition: AdafruitIO_Dashboard.cpp:104
AdafruitIO_Dashboard::addMapBlock
MapBlock * addMapBlock(AdafruitIO_Feed *feed)
Creates a new map block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:206
AdafruitIO_Dashboard::addToggleBlock
ToggleBlock * addToggleBlock(AdafruitIO_Feed *feed)
Creates a new toggle block element on a dashboard connected to provided feed.
Definition: AdafruitIO_Dashboard.cpp:115
Generated by   doxygen 1.8.13