diff --git a/LICENSE b/LICENSE index 4e961d04..bee399aa 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 Adafruit Industries +Copyright (c) 2020-2021 Adafruit Industries Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index e8fab8d3..3eabdf9f 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,24 @@ -# Wippersnapper Arduino -Arduino Library for Adafruit IO Wippersnapper, the no-code IoT interface on Adafruit.io. +![Build CI](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/actions/workflows/githubci.yml/badge.svg) -NOTE: This library in beta and is actively being developed, please report any bugs on the issue page of this repository. +# Wippersnapper Arduino BETA +Arduino Library for Adafruit IO Wippersnapper beta, the no-code IoT interface on Adafruit.io. -## Installation +NOTE: This software is in early beta and is in active development. -Prior to installation, make sure you have your Arduino IDE configured for the board you're using with this library: +Please report bugs on the [Adafruit IO Support Page](https://io.adafruit.com/support). -Supported SAMD51 Hardware: -* [Adafruit Metro M4 AirLift Express](https://learn.adafruit.com/adafruit-metro-m4-express-airlift-wifi/setup) -* [Adafruit PyPortal](https://learn.adafruit.com/adafruit-pyportal/setup) +## Get Wippersnapper +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. -Supported ESP32-S2 Hardware: -* [Adafruit FunHouse](https://learn.adafruit.com/adafruit-funhouse/arduino-ide-setup) +## Supported Hardware +Wippersnapper currently supports the following hardware. Don't see your board? Don't worry - we'll be adding more hardware over time. -Supported ESP32 Hardware: -* [Adafruit Huzzah32](https://learn.adafruit.com/adafruit-huzzah32-esp32-feather/using-with-arduino-ide) +ESP32-S2 +* Adafruit FunHouse -Supported ESP8266 Hardware: -* [Adafruit Huzzah8266](https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/using-arduino-ide) - - -This library requires the following dependencies to be installed from the Arduino Library Manager: -* [Adafruit MQTT Library](https://github.com/adafruit/Adafruit_MQTT_Library) - - -## Usage -* Download the [latest .ZIP for this library](https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/archive/master.zip) -* Within the Arduino IDE, select Sketch -> Include Library -> Add .ZIP Library -* Select the .ZIP you downloaded -* Within the Arduino IDE, select File -> Examples -> Adafruit Wippersnapper -> Wippersnapper_demo -* In `config.h`, set `IO_USERNAME` and `IO_KEY` to your Adafruit IO Staging credentials. -* In `config.h`, set `WIFI_SSID` and `WIFI_PASS` to your WiFi credentials. -* If you are using an Adafruit AirLift Co-Processor board - uncomment the `//#define USE_AIRLIFT` line. -* On a web browser, navigate to the [Adafruit IO staging website](https://io.adafruit.us/) -* Compile and upload the sketch to your board. -* Your board should automatically run the Wippersnapper demo sketch and connect to Adafruit IO. - -## Hardware Compatibility -The following boards are currently supported by this library: -* Adafruit PyPortal +SAMD51 * Adafruit Metro M4 AirLift Lite -* Adafruit Metro M4 Express -* Adafruit Huzzah ESP8266 -* Adafruit Huzzah ESP32 -* Adafruit FunHouse ESP32-S2 +* Adafruit PyPortal ## Adding Hardware to this library -TODO! - -[Hardware Specification for adding boards to WipperSnapper](https://github.com/adafruit/WipperSnapper_Boards) - -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). +We're still working this out and will add instructions for adding your own hardware to Wippersnapper at a later date! \ No newline at end of file