Skip to content

Commit 5010f9a

Browse files
author
brentru
committed
add main .h file headers to all .h files, increase required version of Adafruit MQTT Library
1 parent fdf71e1 commit 5010f9a

21 files changed

Lines changed: 294 additions & 232 deletions

‎src/AdafruitIO.h‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
/*!
22
* @file AdafruitIO.h
33
*
4-
* Adafruit invests time and resources providing this open source code.
5-
* Please support Adafruit and open source hardware by purchasing
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
68
* products from Adafruit!
79
*
8-
* Copyright (c) 2015-2016 Adafruit Industries
9-
* Authors: Tony DiCola, Todd Treece
10-
* Licensed under the MIT license.
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
1113
*
12-
* All text above must be included in any redistribution.
1314
*/
1415

1516
#ifndef ADAFRUITIO_H
@@ -28,17 +29,17 @@
2829

2930
#ifndef ADAFRUIT_MQTT_VERSION_MAJOR
3031
#error \
31-
"This sketch requires Adafruit MQTT Library v0.17.0 or higher. Please install or upgrade using the Library Manager."
32+
"This sketch requires Adafruit MQTT Library v1.0.0 or higher. Please install or upgrade using the Library Manager."
3233
#endif
3334

34-
#if ADAFRUIT_MQTT_VERSION_MAJOR == 0 && ADAFRUIT_MQTT_VERSION_MINOR < 17
35+
#if ADAFRUIT_MQTT_VERSION_MAJOR == 1 && ADAFRUIT_MQTT_VERSION_MINOR < 0
3536
#error \
36-
"This sketch requires Adafruit MQTT Library v0.17.0 or higher. Please install or upgrade using the Library Manager."
37+
"This sketch requires Adafruit MQTT Library v1.0.0 or higher. Please install or upgrade using the Library Manager."
3738
#endif
3839

3940
/**************************************************************************/
4041
/*!
41-
@brief Class for interacting with adafruit.io (AIO)
42+
@brief Class for interacting with Adafruit IO
4243
*/
4344
/**************************************************************************/
4445
class AdafruitIO {

‎src/AdafruitIO_Dashboard.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Dashboard.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_DASHBOARD_H
1316
#define ADAFRUITIO_DASHBOARD_H
1417

‎src/AdafruitIO_Data.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece, Adam Bachman
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Data.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_DATA_H
1316
#define ADAFRUITIO_DATA_H
1417

‎src/AdafruitIO_Definitions.h‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Definitions.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
15+
1216
#ifndef ADAFRUITIO_DEFINITIONS_H_
1317
#define ADAFRUITIO_DEFINITIONS_H_
1418

@@ -36,8 +40,8 @@ class AdafruitIOGroupCallback {
3640
}
3741

3842
const char *feed;
39-
AdafruitIODataCallbackType dataCallback;
40-
AdafruitIOGroupCallback *next_cb;
43+
AdafruitIODataCallbackType dataCallback; // data carried by an AdafruitIOGroupCallback
44+
AdafruitIOGroupCallback *next_cb; // next callback number
4145
};
4246

4347
// Uncomment/comment to turn on/off debug output messages.

‎src/AdafruitIO_Ethernet.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Ethernet.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_ETHERNET_H
1316
#define ADAFRUITIO_ETHERNET_H
1417

‎src/AdafruitIO_Feed.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece, Adam Bachman
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Feed.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_FEED_H
1316
#define ADAFRUITIO_FEED_H
1417

‎src/AdafruitIO_MQTT.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_MQTT.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_MQTT_H
1316
#define ADAFRUITIO_MQTT_H
1417

‎src/AdafruitIO_Time.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece, Adam Bachman
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Time.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_TIME_H
1316
#define ADAFRUITIO_TIME_H
1417

‎src/AdafruitIO_WiFi.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_WiFi.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_WIFI_H
1316
#define ADAFRUITIO_WIFI_H
1417

‎src/blocks/AdafruitIO_Block.h‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Block.h
3+
*
4+
* This is part of the Adafruit IO library for the Arduino platform.
5+
*
6+
* Adafruit invests time and resources providing this open source code,
7+
* please support Adafruit and open-source hardware by purchasing
8+
* products from Adafruit!
9+
*
10+
* Written by Tony DiCola, Todd Treece for Adafruit Industries
11+
*
12+
* BSD license, all text here must be included in any redistribution.
13+
*
14+
*/
1215
#ifndef ADAFRUITIO_BLOCK_H
1316
#define ADAFRUITIO_BLOCK_H
1417

0 commit comments

Comments
 (0)