|
1 |
| -# Wippersnapper Arduino |
2 |
| -Arduino Library for Adafruit IO Wippersnapper, the no-code IoT interface on Adafruit.io. |
| 1 | + |
3 | 2 |
|
4 |
| -NOTE: This library in beta and is actively being developed, please report any bugs on the issue page of this repository. |
| 3 | +# Wippersnapper Arduino BETA |
| 4 | +Arduino Library for Adafruit IO Wippersnapper beta, the no-code IoT interface on Adafruit.io. |
5 | 5 |
|
6 |
| -## Installation |
| 6 | +NOTE: This software is in early beta and is in active development. |
7 | 7 |
|
8 |
| -Prior to installation, make sure you have your Arduino IDE configured for the board you're using with this library: |
| 8 | +Please report bugs on the [Adafruit IO Support Page](https://io.adafruit.com/support). |
9 | 9 |
|
10 |
| -Supported SAMD51 Hardware: |
11 |
| -* [Adafruit Metro M4 AirLift Express](https://learn.adafruit.com/adafruit-metro-m4-express-airlift-wifi/setup) |
12 |
| -* [Adafruit PyPortal](https://learn.adafruit.com/adafruit-pyportal/setup) |
| 10 | +## Get Wippersnapper |
| 11 | +Compiled binaries and UF2 files for supported boards are provided on the [releases page](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/releases) of this repository. |
13 | 12 |
|
14 |
| -Supported ESP32-S2 Hardware: |
15 |
| -* [Adafruit FunHouse](https://learn.adafruit.com/adafruit-funhouse/arduino-ide-setup) |
| 13 | +## Supported Hardware |
| 14 | +Wippersnapper currently supports the following hardware. Don't see your board? Don't worry - we'll be adding more hardware over time. |
16 | 15 |
|
17 |
| -Supported ESP32 Hardware: |
18 |
| -* [Adafruit Huzzah32](https://learn.adafruit.com/adafruit-huzzah32-esp32-feather/using-with-arduino-ide) |
| 16 | +ESP32-S2 |
| 17 | +* Adafruit FunHouse |
19 | 18 |
|
20 |
| -Supported ESP8266 Hardware: |
21 |
| -* [Adafruit Huzzah8266](https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/using-arduino-ide) |
22 |
| - |
23 |
| - |
24 |
| -This library requires the following dependencies to be installed from the Arduino Library Manager: |
25 |
| -* [Adafruit MQTT Library](https://github.com/adafruit/Adafruit_MQTT_Library) |
26 |
| - |
27 |
| - |
28 |
| -## Usage |
29 |
| -* Download the [latest .ZIP for this library](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/archive/master.zip) |
30 |
| -* Within the Arduino IDE, select Sketch -> Include Library -> Add .ZIP Library |
31 |
| -* Select the .ZIP you downloaded |
32 |
| -* Within the Arduino IDE, select File -> Examples -> Adafruit Wippersnapper -> Wippersnapper_demo |
33 |
| -* In `config.h`, set `IO_USERNAME` and `IO_KEY` to your Adafruit IO Staging credentials. |
34 |
| -* In `config.h`, set `WIFI_SSID` and `WIFI_PASS` to your WiFi credentials. |
35 |
| -* If you are using an Adafruit AirLift Co-Processor board - uncomment the `//#define USE_AIRLIFT` line. |
36 |
| -* On a web browser, navigate to the [Adafruit IO staging website](https://io.adafruit.us/) |
37 |
| -* Compile and upload the sketch to your board. |
38 |
| -* Your board should automatically run the Wippersnapper demo sketch and connect to Adafruit IO. |
39 |
| - |
40 |
| -## Hardware Compatibility |
41 |
| -The following boards are currently supported by this library: |
42 |
| -* Adafruit PyPortal |
| 19 | +SAMD51 |
43 | 20 | * Adafruit Metro M4 AirLift Lite
|
44 |
| -* Adafruit Metro M4 Express |
45 |
| -* Adafruit Huzzah ESP8266 |
46 |
| -* Adafruit Huzzah ESP32 |
47 |
| -* Adafruit FunHouse ESP32-S2 |
| 21 | +* Adafruit PyPortal |
48 | 22 |
|
49 | 23 | ## Adding Hardware to this library
|
50 |
| -TODO! |
51 |
| - |
52 |
| -[Hardware Specification for adding boards to WipperSnapper](https://github.com/adafruit/WipperSnapper_Boards) |
53 |
| - |
54 |
| -Communication between this library and the MQTT broker uses protocol buffers for serialized data. The raw protocol buffers used by this project are located [here](https://github.com/adafruit/WipperSnapper_ProtoBuf). This library contains compiled `.pb.h` and `.pb.c` protocol buffer messages generated by [nanopb](https://github.com/nanopb/nanopb). |
| 24 | +We're still working this out and will add instructions for adding your own hardware to Wippersnapper at a later date! |
0 commit comments