1
1
# Adafruit IO Arduino Library [ ![ Build Status] ( https://travis-ci.org/adafruit/Adafruit_IO_Arduino.svg?branch=master )] ( https://travis-ci.org/adafruit/Adafruit_IO_Arduino )
2
2
3
+ This library provides a simple device independent interface for interacting with [ Adafruit IO] ( https://io.adafruit.com ) using Arduino.
4
+ It allows you to switch beween WiFi (ESP8266, M0 WINC1500, & WICED), Cellular (32u4 FONA), and Ethernet (Ethernet FeatherWing)
5
+ with only a two line change in your sketch.
6
+
7
+ ## Dependencies
8
+
9
+ This library requires the latest version of the [ Arduino IDE] ( https://www.arduino.cc/en/Main/Software ) (tested with v1.6.10).
10
+
11
+ ### Adafruit Feather HUZZAH ESP8266 & Adafruit HUZZAH ESP8266 Breakout
12
+
13
+ * Latest version of the [ ESP8266 Arduino Core] ( https://github.com/esp8266/Arduino#installing-with-boards-manager )
14
+ * Latest version of the [ Adafruit MQTT Library] ( https://github.com/adafruit/Adafruit_MQTT_Library )
15
+
16
+ ### Adafruit Feather M0 WiFi with ATWINC1500
17
+
18
+ * Latest version of the [ Arduino SAMD Arduino Core] ( https://github.com/arduino/ArduinoCore-samd )
19
+ * Latest version of the [ Adafruit SAMD Arduino Core] ( https://github.com/adafruit/ArduinoCore-samd )
20
+ * Latest version of the [ Adafruit MQTT Library] ( https://github.com/adafruit/Adafruit_MQTT_Library )
21
+
22
+ ### Adafruit WICED Feather WiFi
23
+
24
+ * Latest version of the [ Adafruit WICED Arduino Core] ( https://github.com/adafruit/Adafruit_WICED_Arduino )
25
+ * Latest version of the [ Adafruit MQTT Library] ( https://github.com/adafruit/Adafruit_MQTT_Library )
26
+
27
+ ### Adafruit Feather 32u4 FONA
28
+
29
+ * Latest version of the [ Adafruit AVR Arduino Core] ( https://github.com/adafruit/Adafruit_Arduino_Boards )
30
+ * Latest version of the [ Adafruit MQTT Library] ( https://github.com/adafruit/Adafruit_MQTT_Library )
31
+ * Latest version of the [ Adafruit FONA Library] ( https://github.com/adafruit/Adafruit_FONA )
32
+
33
+ ### Adafruit Ethernet FeatherWing
34
+
35
+ The Ethernet FeatherWing will also require a 32u4, M0, or ESP8266 based Feather. Any Arduino cores
36
+ required by the host Feather board will also be required.
37
+
38
+ * Latest version of the [ Adafruit Ethernet2 Library] ( https://github.com/adafruit/Ethernet2 )
39
+ * Latest version of the [ Adafruit MQTT Library] ( https://github.com/adafruit/Adafruit_MQTT_Library )
40
+
41
+ ## Usage
42
+
43
+ The included examples sketches will walk you through all of the features of the library.
44
+ They can be used on all platforms, but they default to WiFi. To change between platforms,
45
+ you will need to change two lines of code in the example. It is recommended that you start with
46
+ one of the Adafruit WiFi feathers before moving on to Cellular or Ethernet.
47
+
48
+ The examples below demonstrate how to switch between platforms.
49
+
50
+ ### WiFi (ESP8266, M0 WINC1500, WICED)
51
+
52
+ ``` ino
53
+ #include " AdafruitIO_WiFi.h"
54
+ AdafruitIO_WiFi io (IO_USERNAME, IO_KEY, "your_wifi_ssid", "your_wifi_pass");
55
+ ```
56
+
57
+ ### Cellular (32u4 FONA)
58
+
59
+ ```ino
60
+ #include "AdafruitIO_FONA.h"
61
+ AdafruitIO_FONA io(IO_USERNAME, IO_KEY);
62
+ ```
63
+
64
+ If you need to set APN info, you can do so by adding a call to ` io.setAPN() ` after ` io.connect() ` in the ` setup() ` function.
65
+
66
+ ``` ino
67
+ void setup () {
68
+
69
+ // start the serial connection
70
+ Serial.begin(115200);
71
+
72
+ // connect to io.adafruit.com
73
+ io.connect();
74
+
75
+ io.setAPN(F("your_apn"), F("your_apn_user"), F("your_apn_pass"));
76
+
77
+ }
78
+ ```
79
+
80
+ ### Ethernet (Ethernet FeatherWing)
81
+
82
+ ``` ino
83
+ #include " AdafruitIO_Ethernet.h"
84
+ AdafruitIO_Ethernet io (IO_USERNAME, IO_KEY);
85
+ ```
86
+
3
87
## Compatibility
4
88
89
+ Last test with `v2.0.0` on 08/10/2016.
90
+
5
91
Example | ESP8266 | M0 WINC1500 | WICED | FONA 32u4 | Ethernet* |
6
92
------------------ | :----------: | :----------: | :---------: | :---------: | :--------: |
7
93
00_publish | ✓ | ✓ | ✓ | ✓ | ✓ |
@@ -11,7 +97,7 @@ Example | ESP8266 | M0 WINC1500 | WICED | FONA 32u4 | E
11
97
04_location | ✓ | ✓ | ✓ | ✓ | ✓ |
12
98
05_type_conversion | ✓ | ✓ | ✓ | ✓ | ✓ |
13
99
14
- * Feather ethernet wing tested with Feather M0 Proto
100
+ * * Feather ethernet wing tested with Feather M0 Proto*
15
101
16
102
## License
17
103
Copyright (c) 2016 [Adafruit Industries](https://adafruit.com). Licensed under the [MIT license](/LICENSE?raw=true).
0 commit comments